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

Question

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

我怎么能在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。