Maven javadocプラグイン - 特定のクラスのみを含めるにはどうすればいいですか？

Question

Maven javadocプラグインを使用すると、特定のパッケージを除外できますが、たくさんのパッケージがあり、Javadocを生成したいクラスはほんの一握りです。

除外するのではなく含める方法はありますか？

javadocを必要とするパッケージとそうでないクラスがあるため、パッケージレベルではなくクラスレベルで作業したいと思います。

Answer 1

私はJavadocを望んでいたと私はしたくなかったそれらのパッケージ内のクラスを与えたクラスを含む二つのパッケージを指定するsourcepath設定オプションを使用しましたJavadocのデフォルトアクセス。 show設定オプションをpublicに設定すると、Javadocが公開されているクラスを選択することができました。以下の完全な設定：

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-javadoc-plugin</artifactId> 
    <configuration> 
     <links> 
      <link>http://java.sun.com/j2se/1.5.0/docs/api/</link> 
     </links> 
     <source>1.5</source> 
     <show>public</show> 
     <doctitle>Foo API</doctitle> 
     <title>Foo API</title> 
     <bottom><![CDATA[Copyright notice]]></bottom> 
     <sourcepath>${basedir}/src/main/java/com/foo/api;${basedir}/src/main/java/com/bar/api</sourcepath> 
    </configuration> 
</plugin> 

はしかし、これは本質的な回避策であると私は強くそれはjavadocのユーティリティでサポートされている、これはのmaven-javadocによってプラグインに対してenchancementでなければならないこと蒋介石さんのコメントに同意します。 http://jira.codehaus.org/browse/MJAVADOC

Answer 2

私が知る限り、パッケージレベルでしかフィルタリングできません。しかし、Javadocは公開型と保護型に対してのみ生成されます。型がデフォルトスコープまたはプライベートである場合、それらの型はjavadocを生成しません。デフォルトスコープにすることは、パッケージ内の他のタイプでも可視であることを意味します。javadocが必要ない場合は、おそらく人々がそのタイプを使用しないようにするため、これはおそらく有効な範囲です。

excludePackageNames設定では、ワイルドカードを使用できます。したがって、これを可能にするパッケージ名の規則がある限り、大多数のパッケージを除外することができます。

これらのパッケージがあるとします。

com.foo 
com.foo.api 
com.foo.internal 
com.foo.internal.core 
com.foo.internal.util 
com.foo.internal.ui 
com.foo.ui 

とあなただけのfoo、foo.apiとfoo.uiを公開する、このパターンは動作します：

<excludePackageNames>com.foo.internal.*:com.foo.bob</excludePackageNames> 

あなたが代わりに別々のパッケージに問題の種類を移動することができますが、これではありませんそうするべき十分な理由。

これらのタイプのjavadocを生成する際に発生する問題は何ですか？

Answer 3

maven-javadoc-pluginを使用すると、特定のJavaクラスを指定することはできません（ただし、javadocユーティリティで行うことができます。下記参照）。ただし、javadoc：javadocの目標の構成オプションであるsourcepathを使用すると、特定のパッケージを構成できます。この例は、次のとおりです。この例では

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-javadoc-plugin</artifactId> 
    <version>2.5</version> 
    <configuration> 
     <charset>UTF-8</charset> 
     <docencoding>UTF-8</docencoding> 
     <docfilessubdirs>true</docfilessubdirs> 
     <links> 
      <link>http://java.sun.com/j2se/1.5.0/docs/api/</link> 
     </links> 
     <show>protected</show> 
     <source>1.5</source> 
     <sourcepath>${basedir}/src/main/java/com/acme/foo</sourcepath> 
    </configuration> 
    <reportSets> 
     <reportSet> 
      <reports> 
       <report>javadoc</report> 
      </reports> 
     </reportSet> 
    </reportSets> 
</plugin> 

を、（サブパッケージを含む）com.acme.fooパッケージの下のすべてのクラスは、javadocが生成されています。

このMavenプラグインは、単にSun's javadoc utilityのラッパーです。そのため、javadocのドキュメントと設定のほとんどは、このプラグインにも当てはまります。 javadoc sourcepath parameterに関するSunのマニュアルを参照してください。

maven-javadoc-pluginの機能が異なる領域では、sourcepathパラメータに関するSunのマニュアルには、javadocユーティリティでgenerate javadoc for specific classesを使用することが可能であることが記載されています。この機能は、maven-javadoc-pluginでは使用できません。この例は、Sunのマニュアルに示されている：最後に

C:> cd C:\home\src\java\awt 
    C:> javadoc -d C:\home\html Button.java Canvas.java Graphics*.java 

Answer 4

それは、単にだあなたはMaven2を-プラグイン、例えばから構成タグ<subpackages/>を使用する場合：

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-javadoc-plugin</artifactId> 
    <version>2.7</version> 
    <configuration> 
     <sourceEncoding>ISO-8859-1</sourceEncoding> 
     <quiet>true</quiet> 
     <aggregate>true</aggregate> 
     <code>javadoc:aggregate</code> 
     <code>javadoc:test-aggregate</code>   
     <doclet>gr.spinellis.umlgraph.doclet.UmlGraphDoc</doclet> 
     <docletArtifact> 
      <groupId>gr.spinellis</groupId> 
      <artifactId>UmlGraph</artifactId> 
      <version>4.6</version> 
     </docletArtifact> 
     <additionalparam> 
      -inferrel -inferdep -quiet -hide java.* 
      -collpackages java.util.* -qualify 
      -postfixpackage -nodefontsize 9 
      -nodefontpackagesize 7       
     </additionalparam> 

     <subpackages> 
      de.interforum.gms.db.domain:de.interforum.sdr.db.domain 
     </subpackages> 

    </configuration> 
    <executions> 
     <execution> 
     <goals> 
      <goal>javadoc</goal> 
      <goal>test-javadoc</goal> 
     </goals> 
     <phase>site</phase> 
     <configuration> 
      <!-- Specific configuration for the given reports ... --> 
     </configuration> 
     </execution> 
    </executions> 
</plugin> 

Answer 5

のmaven-javadocによってプラグインのバージョン2.9は、あなたの設定でこれを行うことができますので。

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-javadoc-plugin</artifactId> 
    <version>2.9</version> 
    <configuration> 
    .... 
    <sourceFileIncludes> 
     <include>Foo.java</include> 
     <include>Bar.java</include> 
    </sourceFileIncludes> 
    <sourcepath>${basedir}/src/main/java/path/to/foo-and-bar</sourcepath> 
    .... 
    </configuration> 
    .... 

...上記のクラスだけを含むJavadocサイトを構築します。