```
@Deprecated(since="9",
            forRemoval=true)
public abstract class Doclet
extends Object
```
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.

这是doclet的起始类的示例，显示了入口点方法。起始类必须导入com.sun.javadoc。*并实现start(RootDoc)方法，如package description中所述。如果doclet采用命令行选项，它还必须实现optionLength和validOptions 。
支持自1.1以来添加的语言功能的doclet（例如泛型和注释）应通过实现languageVersion来指示这languageVersion 。如果没有这个，doclet不应该调用自1.5以来添加的任何Doclet API方法，并且修改了其他几个方法的结果，以便隐藏doclet中的新构造（例如类型参数）。

要启动doclet，请传递-doclet然后在javadoc工具命令行上传递起始类的完全限定名称。

构造方法摘要

构造方法
构造器	描述
`Doclet()`	不推荐使用，要删除：此API元素将在以后的版本中删除。

方法摘要

所有方法静态方法具体的方法弃用的方法
变量和类型	方法	描述
`static LanguageVersion`	`languageVersion()`	不推荐使用，要删除：此API元素将在以后的版本中删除。返回此doclet支持的Java编程语言版本。
`static int`	`optionLength(String option)`	不推荐使用，要删除：此API元素将在以后的版本中删除。检查doclet添加的选项。
`static boolean`	`start(RootDoc root)`	不推荐使用，要删除：此API元素将在以后的版本中删除。在此处生成文档。
`static boolean`	`validOptions(String[][] options, DocErrorReporter reporter)`	不推荐使用，要删除：此API元素将在以后的版本中删除。检查选项是否具有正确的参数。

声明方法的类 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造方法详细信息
  - Doclet
```
public Doclet()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
- 方法详细信息
  - start
```
public static boolean start(RootDoc root)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    在此处生成文档。所有doclet都需要此方法。
    
    参数
    
    root - 将RootDoc提供给方法。
    
    结果
    
    成功的真实。
  - optionLength
```
public static int optionLength(String option)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    检查doclet添加的选项。返回必须在命令行上为给定选项指定的参数数。例如，“ - d docs”将返回2。
    如果doclet包含任何选项，则此方法是必需的。如果缺少此方法，Javadoc将为每个选项打印无效标志错误。
    
    参数
    
    option - 返回参数数量的选项。
    
    结果
    
    选项的命令行上的参数数量，包括选项名称本身。零回报意味着选项未知。负值表示发生错误。
  - validOptions
```
public static boolean validOptions(String[][] options,
                                   DocErrorReporter reporter)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    检查选项是否具有正确的参数。
    此方法不是必需的，但建议使用此方法，因为如果此方法不存在，则每个选项都将被视为有效。如果不存在，它将优雅地默认（为真）。
    
    打印选项相关的错误消息（使用提供的DocErrorReporter）是此方法的责任。
    
    参数
    
    options - 提供有效选项作为字符串数组。
    
    reporter - 负责这些选项的DocErrorReporter。
    
    结果
    
    如果选项有效，则为true。
  - languageVersion
```
public static LanguageVersion languageVersion()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    返回此doclet支持的Java编程语言版本。
    支持比1.1更新的语言版本的任何doclet都需要此方法。
    
    结果
    
    此doclet支持的语言版本。
    
    从以下版本开始：
    
    1.5

Class Doclet

构造方法摘要

方法摘要

声明方法的类 java.lang.Object

构造方法详细信息

Doclet

方法详细信息

start

optionLength

validOptions

languageVersion