为多模块项目聚合 JXR 报告

JXR Plugin的聚合参数可用于为多模块项目生成 JXR 文件。使用此参数,您可以选择为整个项目(所有模块)生成一组已编译的 JXR 文件或为每个模块生成一组 JXR 文件。

例如,您具有以下目录结构:

Project
|-- pom.xml
|-- Module1
|   |-- src
|   |   `-- main
|   |       `-- java
|   |           `-- com
|   |               `-- module1
|   |                   `-- app
|   |                       `-- Module1App.java
|   `-- pom.xml
|-- Module2
|   |-- src
|   |   `-- main
|   |       `-- java
|   |           `-- com
|   |               `-- module2
|   |                   `-- app
|   |                       `-- Module2App.java
|   `-- pom.xml
`-- Module3
    |-- src
    |   `-- main
    |       `-- java
    |           `-- com
    |               `-- module3
    |                   `-- app
    |                       `-- Module3App.java
    `-- pom.xml

您的pom.xml中有以下配置:

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jxr-plugin</artifactId>
        <version>2.2</version>
        <configuration>
          ...
          <aggregate>true</aggregate>
          ...
        </configuration>
      </plugin>
    </plugins>
  ...
  </reporting>
  ...
</project>

当您从父目录Project 执行mvn site时,将在Project的目标目录中创建一组 JXR 文件,其中包含项目子模块的所有 JXR 文件。否则,如果将aggregate参数设置为false,将在 Module1 的目标目录中生成一Module1的JXR 文件,在Module2的目标目录中生成另一组Module2的 JXR 文件,依此类推。