13

我有一个多模块 Maven 构建，我想在我的根模块中生成一个聚合的 Scaladoc，类似于 maven-javadoc-plugin 的聚合目标。我的第一次尝试是：

<project ...>
    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <artifactId>maven-site-plugin</artifactId>
                    <configuration>
                        <reportPlugins>
                            <plugin>
                                <artifactId>maven-project-info-reports-plugin</artifactId>
                            </plugin>
                            <plugin>
                                <groupId>net.alchim31.maven</groupId>
                                <artifactId>scala-maven-plugin</artifactId>
                                <reports>
                                    <report>doc</report>
                                </reports>
                                <configuration>
                                    <aggregateDirectOnly>false</aggregateDirectOnly>
                                    <sendJavaToScalac>false</sendJavaToScalac>
                                </configuration>
                            </plugin>
                            <plugin>
                                <artifactId>maven-javadoc-plugin</artifactId>
                                <reports>
                                    <report>aggregate</report>
                                </reports>
                            </plugin>
                        </reportPlugins>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

但是，aggregateDirectOnly 属性似乎没有任何效果。我总是只获得单个 jar 类型 POM 的 Scaladoc。

我也尝试将 forceAggregate 设置为 true，但它也没有效果。

这个怎么做？

4

1 回答 1

6

这并没有完全按照要求回答问题，但在 ScalaDoc 能够解析 JavaDoc 注释之前，它实际上可能是混合 java/scala 项目的首选解决方案。它生成一个单一的聚合 JavaDoc，其中还包括来自项目的所有 Scala 源文件的文档。

解决方案很简单：配置 Maven 使用GenJavaDoc Scala 编译器插件，以便 ScalaDocs 可以转换为 JavaDocs。然后，使用正常javadoc:aggregate目标将项目聚合为正常。

这是执行此操作的示例 Maven 配置文件。它配置 Scala 编译器生成与 Scala 源代码对应的 JavaDocs，配置 Maven 将genjavadocScala 编译器创建的目录视为源目录，然后配置 javadoc 插件本身（如果您没有特殊的 JavaDoc，则最后一个可能是可选的插件配置要求）。

<profile>
  <id>javadoc</id>
  <build>
    <plugins>
      <plugin>
        <groupId>net.alchim31.maven</groupId>
        <artifactId>scala-maven-plugin</artifactId>
        <executions>
          <execution>
            <id>doc</id>
            <phase>generate-sources</phase>
            <goals>
              <goal>compile</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <args>
            <arg>-P:genjavadoc:out=${project.build.directory}/genjavadoc</arg>
          </args>
          <compilerPlugins>
            <compilerPlugin>
              <groupId>com.typesafe.genjavadoc</groupId>
              <artifactId>genjavadoc-plugin_${scala.binary.full.version}</artifactId>
              <version>0.4</version>
            </compilerPlugin>
          </compilerPlugins>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>build-helper-maven-plugin</artifactId>
        <executions>
          <execution>
            <phase>generate-sources</phase>
            <goals>
              <goal>add-source</goal>
            </goals>
            <configuration>
              <sources>
                <source>${project.build.directory}/genjavadoc</source>
              </sources>
            </configuration>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.9</version>
        <configuration>
          <minmemory>64m</minmemory>
          <maxmemory>2g</maxmemory>
          <outputDirectory>${project.build.directory}</outputDirectory>
          <detectLinks>true</detectLinks>
        </configuration>
      </plugin>
    </plugins>
  </build>
</profile>
于 2013-04-29T21:24:49.197 回答