maven-javadoc-plugin - 使用 maven-javadoc-plugin 从包中记录一个或多个类

Question

我只想记录一个包中的两个类。在标准的 javadoc 工具中，它类似于：C:> javadoc -d C:\home\html C:\home\src\java\awt\classA.java C:\home\src\java\awt\classB。爪哇

我怎样才能在 maven-javadoc-plugin 中做到这一点？

Answer 1

sourceFileIncludes应该做你正在寻找的东西。

https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#sourceFileIncludes

这是一个例子：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.10.1</version>
    <configuration>
        <sourceFileIncludes>
            <include>com/mycompany/myproject/MyClass.java</include>
        </sourceFileIncludes>
    </configuration>
</plugin>

更新：

我在我的一个 maven 项目上尝试了这一点，它在包级别上工作，但不是在单个类上工作。看起来这些开放的 Maven 问题是原因：

http://jira.codehaus.org/browse/MJAVADOC-388

http://jira.codehaus.org/browse/MJAVADOC-365

请注意，问题 #365 实际上与 sourceFileExcludes 相关；maven-javadoc-plugin 2.11 计划对此进行修复。