モジュール jdk.javadoc
パッケージ com.sun.javadoc
ノート: このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
ドックレットはjavadocにより呼び出され、このAPIを使ってプログラム情報をファイルに書き出します。 たとえば、標準的なドックレットはデフォルトで呼び出され、HTMLファイルにドキュメンテーションを書き出すことができます。
この呼出しは、抽象Doclet
クラスにより定義されます。エントリ・ポイントは、次のstart
メソッドです。
public static boolean start(RootDoc root)
RootDoc
インスタンスは、プログラム構造情報のルートを保持します。 このルートから、他のすべてのプログラム構造情報を取り出すことができます。
用語
javadocの呼出し時に、パッケージ名とソース・ファイル名を渡します。これらは、指定されたパッケージおよびクラスと呼ばれます。 また、Javadocオプションも渡します。アクセス制御 Javadocオプション(-public
、-protected
、-package
、および-private
)を指定すると、プログラム要素がフィルタ処理され、含まれるセットまたはドキュメント化されたセットと呼ばれる結果セットが生成されます。 (フィルタ処理されていないセットも、allClasses(false)
経由で使用できます。)
ClassDoc
、allClasses()
、およびfindClass(String)
で示されているように、このAPIではクラスという用語は通常クラスまたはインタフェースの略として使用されます。 Doc.isClass()
で示されているように、インタフェースの対語としてのクラスを意味することはまれです。 2つの目の意味では、このAPIは通常クラス、列挙型、エラー、および例外の4種類のクラスを呼び出します。 このAPIでは、各プログラム要素の詳細な説明で、どの意味が使われているかを明示的に示しています。
修飾クラス名またはインタフェース名とは、パッケージ名が付加された名前です(java.lang.String
など)。 修飾されていない名前には、パッケージ名が含まれません(String
など)。
例
処理対象クラスの@param
タグ内の情報を表示するドックレットの例を次に示します。
import com.sun.javadoc.*; public class ListParams extends Doclet { public static boolean start(RootDoc root) { ClassDoc[] classes = root.classes(); for (int i = 0; i < classes.length; ++i) { ClassDoc cd = classes[i]; printMembers(cd.constructors()); printMembers(cd.methods()); } return true; } static void printMembers(ExecutableMemberDoc[] mems) { for (int i = 0; i < mems.length; ++i) { ParamTag[] params = mems[i].paramTags(); System.out.println(mems[i].qualifiedName()); for (int j = 0; j < params.length; ++j) { System.out.println(" " + params[j].parameterName() + " - " + params[j].parameterComment()); } } } }Javadoc APIのインタフェースおよびメソッドは、赤色で示されています。
Doclet
は、ドックレットの呼出しインタフェースを指定する抽象クラスです。Doclet
には、クラス情報またはインタフェース情報が保持されます。ExecutableMemberDoc
は、MethodDoc
およびConstructorDoc
のスーパー・インタフェースであり、ParamTag
には、@param
タグから得た情報が保持されます。
コマンド行で次のように指定して、このドックレットを呼び出すとします。
javadoc -doclet ListParams -sourcepath <source-location> java.util次のような出力が生成されます。
... java.util.ArrayList.add index - index at which the specified element is to be inserted. element - element to be inserted. java.util.ArrayList.remove index - the index of the element to removed. ...
-
インタフェースのサマリー インタフェース 説明 AnnotatedType 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。AnnotationDesc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。AnnotationDesc.ElementValuePair 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。AnnotationTypeDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。AnnotationTypeElementDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。AnnotationValue 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。ClassDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。ConstructorDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。Doc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。DocErrorReporter 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。ExecutableMemberDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。FieldDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。MemberDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。MethodDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。PackageDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。Parameter 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。ParameterizedType 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。ParamTag 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。ProgramElementDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。RootDoc 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。SeeTag 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。SerialFieldTag 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。SourcePosition 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。Tag 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。ThrowsTag 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。Type 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。TypeVariable 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。WildcardType 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。 -
クラスのサマリー クラス 説明 Doclet 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。 -
列挙型のサマリー 列挙型 説明 LanguageVersion 非推奨。 このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。