com.sun.javadoc
インタフェース RootDoc

すべてのスーパーインタフェース:

Comparable<Object>, Doc, DocErrorReporter

public interface RootDoc
extends Doc, DocErrorReporter

javadoc の特定の実行に関するプログラム構造情報のルートを表します。このルートから、ほかのすべてのプログラム構造情報を取り出すことができます。また、ユーザーが指定したパッケージ、クラス、およびオプションなどの、コマンド行情報も表します。

導入されたバージョン:

1.2

メソッドの概要

ClassDoc[]	classes() すべてのパッケージの組み込みクラスとインタフェースを返します。
ClassDoc	classNamed(String qualifiedName) 指定されたクラス名またはインタフェース名に対応する ClassDoc を返します。
String[][]	options() コマンド行オプションを返します。
PackageDoc	packageNamed(String name) 指定されたパッケージ名に対応する PackageDoc を返します。
ClassDoc[]	specifiedClasses() コマンド行でソースファイル名としての指定クラスとインタフェースを返します。
PackageDoc[]	specifiedPackages() コマンド行の指定パッケージを返します。

インタフェース com.sun.javadoc.Doc から継承されたメソッド

commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags

インタフェース com.sun.javadoc.DocErrorReporter から継承されたメソッド

printError, printError, printNotice, printNotice, printWarning, printWarning

メソッドの詳細

options

String[][] options()

コマンド行オプションを返します。

たとえば、次のように指定された場合、

     javadoc -foo this that -bar other ...

次の戻り値が返されます。

      options()[0][0] = "-foo"
      options()[0][1] = "this"
      options()[0][2] = "that"
      options()[1][0] = "-bar"
      options()[1][1] = "other"

戻り値:

String 型配列の配列

specifiedPackages

PackageDoc[] specifiedPackages()

コマンド行の指定パッケージを返します。-subpackages および -exclude オプションが使用されている場合、非除外パッケージはすべて返されます。

戻り値:

コマンド行で指定されたパッケージ

specifiedClasses

ClassDoc[] specifiedClasses()

コマンド行でソースファイル名としての指定クラスとインタフェースを返します。

戻り値:

コマンド行で指定されたクラスとインタフェース

classes

ClassDoc[] classes()

すべてのパッケージの組み込みクラスとインタフェースを返します。

戻り値:

すべてのパッケージに含まれるクラスとインタフェース

packageNamed

PackageDoc packageNamed(String name)

指定されたパッケージ名に対応する PackageDoc を返します。

パラメータ:

name - パッケージ名

戻り値:

指定されたパッケージを保持する PackageDoc。このパッケージが参照されていない場合は、null

classNamed

ClassDoc classNamed(String qualifiedName)

指定されたクラス名またはインタフェース名に対応する ClassDoc を返します。

パラメータ:

qualifiedName - 修飾クラスまたはパッケージの名前

戻り値:

指定されたクラスを保持する ClassDoc。このクラスが参照されていない場合は、null