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

すべてのスーパーインタフェース:
Comparable, Doc, DocErrorReporter

public interface RootDoc
extends Doc, DocErrorReporter

このクラスには、javadoc の特定の実行時における情報 (特に、パッケージ、クラス、 ユーザが指定したオプションなど) が格納されます。

導入されたバージョン:
JDK1.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, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags
 
インタフェース com.sun.javadoc.DocErrorReporter から継承したメソッド
printError, printError, printNotice, printNotice, printWarning, printWarning
 

メソッドの詳細

options

public 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

public PackageDoc[] specifiedPackages()
コマンド行で指定されたパッケージを返します。

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

specifiedClasses

public ClassDoc[] specifiedClasses()
コマンド行で指定されたクラスとインタフェースを返します。

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

classes

public ClassDoc[] classes()
ドキュメント生成されるクラスとインタフェースを返します。

戻り値:
ドキュメント生成されるクラスとインタフェース

packageNamed

public PackageDoc packageNamed(String name)
指定されたパッケージ名に対応する PackageDoc を返します。

パラメータ:
name - パッケージ名
戻り値:
指定されたパッケージを保持する PackageDoc。このパッケージが参照されて いない場合は、null

classNamed

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

パラメータ:
qualifiedName - 修飾されたクラス名 (たとえば、パッケージ名を含むクラス名)
戻り値:
指定されたクラスを保持する ClassDoc。このクラスが参照されていない場合 は、null


バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.