モジュール jdk.javadoc
パッケージ com.sun.javadoc

インタフェースRootDoc

  • すべてのスーパー・インタフェース:
    Comparable<Object>, Doc, DocErrorReporter
    @Deprecated(since="9",
            forRemoval=true)
public interface RootDoc
extends Doc, DocErrorReporter
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    このパッケージの宣言は、パッケージjdk.javadoc.docletの宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
    javadocの特定の実行に関するプログラム構造情報のルートを表します。 このルートから、他のすべてのプログラム構造情報を取り出すことができます。 また、ユーザーが指定したパッケージ、クラス、およびオプションなどの、コマンド行情報も表します。
    導入されたバージョン:
    1.2

    • メソッドの詳細

      • options

        String[][] options()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        コマンド行オプションを返します。

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

             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()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        コマンド行の指定パッケージを返します。 -subpackagesおよび-excludeオプションが使用されている場合、非除外パッケージはすべて返されます。
        戻り値:
        コマンド行で指定されたパッケージ。

      • specifiedClasses

        ClassDoc[] specifiedClasses()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        コマンド行でソース・ファイル名としての指定クラスとインタフェースを返します。
        戻り値:
        コマンド行で指定されたクラスとインタフェース。

      • classes

        ClassDoc[] classes()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        すべてのパッケージの組み込みクラスとインタフェースを返します。
        戻り値:
        すべてのパッケージに含まれるクラスとインタフェース。

      • packageNamed

        PackageDoc packageNamed​(String name)
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        指定されたパッケージ名に対応するPackageDocを返します。
        パラメータ:
        name - パッケージ名
        戻り値:
        指定されたパッケージを保持するPackageDoc。このパッケージが参照されていない場合は、null。

      • classNamed

        ClassDoc classNamed​(String qualifiedName)
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        指定されたクラス名またはインタフェース名に対応するClassDocを返します。
        パラメータ:
        qualifiedName - 修飾クラスまたはパッケージの名前
        戻り値:
        指定されたクラスを保持するClassDoc。このクラスが参照されていない場合は、null。