47.2. Javadoc オプション
概要
Java API のメタデータが Javadoc によって提供されている場合、通常はオプションなしで fromJavadoc
要素を指定すれば十分です。ただし、API マッピングに Java API 全体を含めたくない場合は、Javadoc メタデータをフィルタリングして内容をカスタマイズできます。言い換えると、API コンポーネント Maven プラグインは Javadoc メタデータを反復処理することで API マッピングを生成するため、Javadoc メタデータの不要な部分をフィルタリングすることで、生成される API マッピングのスコープをカスタマイズすることができます。
構文
fromJavadoc
要素には、以下のようにオプションの子要素を設定できます。
<fromJavadoc> <excludePackages>PackageNamePattern</excludePackages> <excludeClasses>ClassNamePattern</excludeClasses> <excludeMethods>MethodNamePattern</excludeMethods> <includeMethods>MethodNamePattern</includeMethods> <includeStaticMethods>[true|false]<includeStaticMethods> </fromJavadoc>
スコープ
以下の抜粋で示されているように、fromJavadoc
要素は、任意で apis
要素の子や api
要素の子として表示できます。
<configuration> <apis> <api> <apiName>...</apiName> ... <fromJavadoc>...</fromJavadoc> </api> <fromJavadoc>...</fromJavadoc> ... </apis> </configuration>
以下のスコープで fromJavadoc
要素を定義できます。
-
api
要素の子として:fromJavadoc
オプションは、api
要素で指定された API クラスにのみ適用されます。 -
apis
要素の子として:fromJavadoc
オプションは、デフォルトですべての API クラスに適用されますが、api
レベルで上書きできます。
オプション
以下のオプションは、fromJavadoc
の子要素として定義できます。
excludePackages
-
API マッピングモデルから Java パッケージを除外するための正規表現 (
java.util.regex
構文) を指定します。正規表現に一致するパッケージ名はすべて除外され、除外されたクラスから派生したすべてのクラスも無視されます。デフォルト値はjavax?\.lang.\*
です。 excludeClasses
-
API マッピングから API ベースクラスを除外するための正規表現 (
java.util.regex
構文) を指定します。正規表現に一致するクラス名はすべて除外され、除外されたクラスから派生するすべてのクラスも無視されます。 excludeMethods
-
API マッピングモデルからメソッドを除外するための正規表現 (
java.util.regex
構文) を指定します。 includeMethods
-
API マッピングモデルのメソッドを含むための正規表現 (
java.util.regex
構文) を指定します。 includeStaticMethods
-
true
の場合、static メソッドも API マッピングモデルに含まれます。デフォルトはfalse
です。