按包聚合 javadoc

Question

假设我有以下包结构：

当我生成 javadoc 时，我将在 index.html 下得到以下内容：

我觉得不方便有两个原因：

您无法真正按包浏览 classes，因为所有列表都是扁平的（这不像浏览文件夹树）
package-info.java只出现在com.company.framework包级别（不包含class），其他两个实际包含class的子包有空的描述。

我想以某种方式“聚合”（或折叠？）包，以便我只能得到 com.company.framework，然后扩展它我只能得到 a 和 b.

使用 Javadoc 可以实现吗？

我的设置（如果需要）：

maven 插件:

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.1.0</version>
            <configuration>
                <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
                <overview>${basedir}/javadoc/overview.html</overview>
            </configuration>
            <executions>
                <execution>
                    <id>aggregate</id>
                    <goals>
                        <goal>aggregate</goal>
                    </goals>
                    <configuration>
                        <reportOutputDirectory>${basedir}/framework-doc/</reportOutputDirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>

我用来构建 javadoc 的命令：

mvn javadoc:aggregate

Answer 1

最后，寻找的正确位置是 javadoc maven 插件的 Grouping Packages 功能。

官方文档：here

样本：

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.1.0</version>
        <configuration>
            <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
            <overview>${basedir}/javadoc/overview.html</overview>
            <groups>
               <group>
                   <title>Package A</title>
                   <packages>com.company.framework.a*</packages>
               </group>
            </groups>
        </configuration>
        <executions>
            <execution>
                <id>aggregate</id>
                <goals>
                    <goal>aggregate</goal>
                </goals>
                <configuration>
                    <reportOutputDirectory>${basedir}/framework-doc/</reportOutputDirectory>
                </configuration>
            </execution>
        </executions>
    </plugin>

按包聚合 javadoc

Aggregate javadoc by packages

java

javadoc

maven-javadoc-plugin