模块 jdk.javadoc

软件包 com.sun.javadoc

Interface RootDoc

All Superinterfaces:

Comparable<Object> ， Doc ， DocErrorReporter

@Deprecated(since="9",
            forRemoval=true)
public interface RootDoc
extends Doc, DocErrorReporter

Deprecated, for removal: This API element is subject to removal in a future version.

The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.

表示一次运行javadoc的程序结构信息的根。 从该根可以提取所有其他程序结构信息。 还表示命令行信息 - 用户指定的包，类和选项。

从以下版本开始：

1.2

方法摘要

变量和类型	方法	描述
ClassDoc[]	classes()	不推荐使用，要删除：此API元素将在以后的版本中删除。 返回所有包中的 included类和接口。
ClassDoc	classNamed(String qualifiedName)	不推荐使用，要删除：此API元素将在以后的版本中删除。 返回指定类或接口名称的ClassDoc。
String[][]	options()	不推荐使用，要删除：此API元素将在以后的版本中删除。 命令行选项。
PackageDoc	packageNamed(String name)	不推荐使用，要删除：此API元素将在以后的版本中删除。 返回指定包名称的PackageDoc。
ClassDoc[]	specifiedClasses()	不推荐使用，要删除：此API元素将在以后的版本中删除。 在命令行 上将类和接口 specified作为源文件名返回。
PackageDoc[]	specifiedPackages()	不推荐使用，要删除：此API元素将在以后的版本中删除。 在命令行上返回包 specified 。

声明方法的接口 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()

Deprecated, for removal: This API element is subject to removal in a future version.

命令行选项。

例如，给定：

  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()

Deprecated, for removal: This API element is subject to removal in a future version.

在命令行上返回包specified 。 如果使用-subpackages和-exclude选项，则返回所有未排除的包。

结果

在命令行上指定的包。

specifiedClasses

ClassDoc[] specifiedClasses()

Deprecated, for removal: This API element is subject to removal in a future version.

在命令行 上将类和接口 specified作为源文件名返回。

结果

命令行中指定的类和接口。

classes

ClassDoc[] classes()

Deprecated, for removal: This API element is subject to removal in a future version.

返回所有包中的 included类和接口。

结果

包括所有包中的类和接口。

packageNamed

PackageDoc packageNamed(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

返回指定包名称的PackageDoc。

参数

name - 包名称

结果

包含指定包的PackageDoc，如果未引用此包，则返回null。

classNamed

ClassDoc classNamed(String qualifiedName)

Deprecated, for removal: This API element is subject to removal in a future version.

返回指定类或接口名称的ClassDoc。

参数

qualifiedName - qualified类或包名称

结果

包含指定类的ClassDoc，如果未引用此类，则返回null。