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



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

Parent
|
|__Module1
|____Package1
|____Package2
|
|__Module2
|____Package3
|____Package4

我希望Javadocs只适用于模块1下的Package2

在父级中定义 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声明插件时,skipsourceFileIncludes。例如:

<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进行了验证。

最新更新