使用 Maven Javadoc 插件可以只为特定包创建 Javadocs 吗？

Question

使用 Maven JavaDoc 插件，我可以只为特定的包创建 Javadocs 吗？我有一个父模块，并且只想为子模块中的选定包生成 Javadoc。例如。

Parent |--Module1 |----Package1 |----Package2 |-- Module2 |----Package3 |----Package4

我希望 Javadocs 仅适用于 Module1 下的 Package2

Answer 1

在父类中定义 javadoc 插件，例如

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.0-M1</version>
    <configuration>
        <skip>true</skip>
    </configuration>
</plugin>

因此，javadoc 生成是可用的，但默认情况下会跳过它。

在module1 中用skip 和sourceFileIncludes 声明插件。例如：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <skip>false</skip>
        <sourceFileIncludes>
            <exclude>Package2/*.java</exclude>
        </sourceFileIncludes>
    </configuration>
</plugin>

这将为module1 启用javadoc 生成，但只针对Package2 中的类。

这已通过 Maven Javadoc 插件的 v3.0.0-M1 进行验证。