Module jdk.javadoc

软件包 jdk.javadoc.doclet

Class StandardDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

All Implemented Interfaces:

Doclet

public class StandardDoclet
extends Object
implements Doclet

该doclet为指定的模块，包和类型生成HTML格式的文档。

另请参见：

Documentation Comment Specification for the Standard Doclet

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet

Doclet.Option

构造方法摘要

构造方法

Constructor	描述
StandardDoclet()

方法摘要

Modifier and Type	方法	描述
String	getName()	返回标识doclet的名称。
Set<Doclet.Option>	getSupportedOptions()	返回所有支持的选项。
SourceVersion	getSupportedSourceVersion()	返回此doclet支持的Java编程语言的版本。
void	init(Locale locale, Reporter reporter)	使用给定的区域设置和错误报告器初始化此doclet。
boolean	run(DocletEnvironment docEnv)	doclet的入口点。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

StandardDoclet

public StandardDoclet()

方法详细信息

init

public void init(Locale locale,
                 Reporter reporter)

说明从接口Doclet复制

使用给定的区域设置和错误报告器初始化此doclet。 这个区域将被记者和doclet组件使用。

Specified by:

init在接口 Doclet

参数

locale - 要使用的语言环境

reporter - 记者要使用

getName

public String getName()

描述从接口Doclet复制

返回标识doclet的名称。 名称是一个没有空格的简单标识符，如The Java™ Language Specification第6.2节“名称和标识符”中定义的。

Specified by:

getName在接口 Doclet

结果

Doclet的名称

getSupportedOptions

public Set<Doclet.Option> getSupportedOptions()

描述从接口Doclet复制

返回所有支持的选项。

Specified by:

getSupportedOptions在接口 Doclet

结果

一个包含所有支持的选项的集合，如果没有，则为空集合

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

说明从接口Doclet复制

返回此doclet支持的Java编程语言的版本。

Specified by:

getSupportedSourceVersion在接口 Doclet

结果

该doclet支持的语言版本通常是最新版本

run

public boolean run(DocletEnvironment docEnv)

说明从接口Doclet复制

doclet的入口点。 进一步的处理将按照该方法的指示进行。

Specified by:

run在接口 Doclet

参数

docEnv - 可以从中提取基本信息

结果

真正的成功