Module  jdk.javadoc
软件包  com.sun.javadoc

Interface RootDoc

  • All Superinterfaces:
    Comparable<Object> ， Doc ， DocErrorReporter
    已过时。
    该包装中的声明已被包装jdk.javadoc.doclet的声明所取代。 有关详细信息，请参阅该软件包的文档中的“ 迁移指南” 。 

    @Deprecated
public interface RootDoc
extends Doc, DocErrorReporter
    表示一次运行javadoc的程序结构信息的根。 从此根可以提取所有其他程序结构信息。 还表示命令行信息 - 用户指定的包，类和选项。
    从以下版本开始：
    1.2

    • 方法详细信息

      • 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​()
        已过时。
        返回命令行中的软件包specified 。 如果使用-subpackages和-exclude选项，则返回所有未排除的包。
        结果
        在命令行中指定的包。

      • specifiedClasses

        ClassDoc[] specifiedClasses​()
        已过时。
        返回类和接口 specified作为命令行上的源文件名。
        结果
        在命令行上指定的类和接口。

      • classes

        ClassDoc[] classes​()
        已过时。
        返回所有包中的 included类和接口。
        结果
        包括所有包中的类和接口。

      • packageNamed

        PackageDoc packageNamed​(String name)
        已过时。
        为指定的包名返回一个PackageDoc。
        参数
        name - 软件包名称
        结果
        一个包含指定包的PackageDoc，如果未引用此包，则为null。

      • classNamed

        ClassDoc classNamed​(String qualifiedName)
        已过时。
        为指定的类或接口名返回ClassDoc。
        参数
        qualifiedName - qualified类或包名称
        结果
        a ClassDoc holding the specified class, null if this class is not referenced.