如何在Maven中包括ScalaDoc选项

Question

我可以手动使用"scaladoc -diagrams .“生成类层次图。

我还可以通过"mvn :doc“使用Maven生成基本的ScalaDoc。

但是，当我从Maven运行ScalaDoc时，如何将“ScalaDoc”放入其中呢？一般来说，我如何在"scaladoc -help“中列出任何选项。

我的pom.xml里有这个，但它不起作用。

        <plugin>
            <groupId>org.scala-tools</groupId>
            <artifactId>maven-scala-plugin</artifactId>
            <version>2.14-SNAPSHOT</version>
            <configuration>
                <args>
                    <arg>-diagrams</arg>
                </args>
            </configuration>
         </plugin>

更新

这也不起作用：

        <plugin>
            <groupId>org.scala-tools</groupId>
            <artifactId>maven-scala-plugin</artifactId>

            <executions>
                <execution>
                    <id>generate-scaladoc</id>
                    <phase>generate-sources</phase>
                    <goals>
                        <goal>doc</goal>
                    </goals>
                    <configuration>
                        <diagrams>true</diagrams>
                        <args>
                            <arg>-diagrams</arg>
                        </args>
                    </configuration>
                </execution>
            </executions>
      </plugin>

Answer 1

我可以使用attach-javadocs执行scala-maven-plugin's为scala项目生成java，如下所示：

                 <plugin>
                    <groupId>net.alchim31.maven</groupId>
                    <artifactId>scala-maven-plugin</artifactId>
                    <version>3.2.0</version>
                    <executions>
                        <execution>
                            <!-- this is so we don't end with a compile error in maven-compiler-plugin -->
                            <phase>process-sources</phase>
                            <goals>
                                <goal>compile</goal>
                                <goal>testCompile</goal>
                            </goals>
                            <configuration>
                            </configuration>
                        </execution>
                        <execution>
                            <id>attach-javadocs</id>
                            <goals>
                                <goal>doc-jar</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>

一旦添加了上述指定的插件配置，只需运行mvn clean install，它将生成javadoc的jar和源jar

Answer 2

我还没有尝试过这种方法，但是通常可以添加executions元素来将目标绑定到maven生命周期的特定phase。看看结合了java和scala项目的这个例子。

            <executions>
                <execution>
                    <id>scala-doc</id>
                    <phase>process-resources</phase> <!-- or wherever -->
                    <goals>
                        <goal>doc</goal>
                    </goals>
                </execution>                                    
            </executions>