maven-javadoc-plugin - maven-javadoc-plugin を使用してパッケージから 1 つ以上のクラスを文書化する

Question

パッケージから 2 つのクラスだけを文書化したい。標準の 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プロジェクトの1つでこれを試してみましたが、パッケージレベルでは機能しましたが、個々のクラスでは機能しませんでした. これらの未解決の Maven の問題が原因のようです。

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

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

問題 #365 は、実際には sourceFileExcludes に関連していることに注意してください。その修正は、maven-javadoc-plugin 2.11 で予定されています。