Maven的Scaladoc选项

Question

我正在寻找scala-maven-plugin有关Maven的帮助。我想生成我的Scaladoc，但是我遇到了一些问题。

实际上，我可以输入以下命令来创建我的Scaladoc：

mvn scala:doc

现在的问题是，在生成Scaladoc时，我想添加一些选项，例如-no-link-warnings。

有谁知道如何做到这一点？我找到了一种方法（下面的代码有效），但是我认为那不是我应该做的方法。

我的pom文件是：

mvn scala:doc

---

编辑

用户Tunaki在第一个答复中建议了一种更好的方法，您可以在此处看到代码。

Answer 1

您的配置完全正确，尽管您可能会有所不同。当前（忘记编译源代码的部分），您有：

<plugin>
    <groupId>net.alchim31.maven</groupId>
    <artifactId>scala-maven-plugin</artifactId>
    <version>3.2.1</version>
    <configuration>
        <args>
            <arg>-no-link-warnings</arg>
        </args>
    </configuration>
</plugin>

通过这种配置，您可以声明的每次执行都scala-maven-plugin将具有附加参数-no-link-warnings。这是因为您在全局配置元素中声明了它。您可以具有特定于插件执行的配置，就像您在编译部分所拥有的配置一样：

<execution>
    <id>Compile</id>
    <goals>
        <goal>compile</goal>
        <goal>testCompile</goal>
    </goals>
    <configuration>
        <args>
            <arg>-dependencyfile</arg>
            <arg>${project.build.directory}/.scala_dependencies</arg>
        </args>
    </configuration>
</execution>

仅当Compile调用执行时才考虑此配置。

因此，最好将配置更改为特定于插件的执行，因为该参数-no-link-warnings确实特定于生成Scaladoc。

这将是最终的插件声明：

<plugin>
    <groupId>net.alchim31.maven</groupId>
    <artifactId>scala-maven-plugin</artifactId>
    <version>3.2.1</version>
    <executions>
        <execution>
            <id>Scaladoc</id>
            <goals>
                <goal>doc</goal>
            </goals>
            <phase>prepare-package</phase>
            <configuration>
                <args>
                    <arg>-no-link-warnings</arg>
                </args>
            </configuration>
        </execution>
        <execution>
            <id>Compile</id>
            <goals>
                <goal>compile</goal>
                <goal>testCompile</goal>
            </goals>
            <configuration>
                <args>
                    <arg>-dependencyfile</arg>
                    <arg>${project.build.directory}/.scala_dependencies</arg>
                </args>
            </configuration>
        </execution>
    </executions>
</plugin>

然后，当您使用mvn package例如打包项目时，将使用正确的参数自动生成Scaladoc。