我正在寻找Maven scala-maven-plugin
的帮助。我想生成我的Scaladoc,但我遇到了一些问题。
我实际上可以创建我的Scaladoc,输入以下命令:
mvn scala:doc
现在的问题是我想在生成Scaladoc时添加一些选项,例如-no-link-warnings
。
有谁知道怎么做?我找到了一种方法(下面的代码可以工作),但我认为这不是我应该做的方式。
我的pom文件是:
<build>
...
<plugins>
<plugin>
<!-- see http://davidb.github.com/scala-maven-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>
<executions>
<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>
...
</plugins>
修改
用户Tunaki在第一个回复中提出了一个更好的方法,你可以在那里看到代码。
答案 0 :(得分:7)
您的配置完全正确,尽管您可以稍微写一下。目前(忘记编译源代码的部分),你有:
<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。