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

Class Doclet

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

    @Deprecated
public abstract class Doclet
extends Object
    这是doclet的起始类的示例，显示了入门点方法。 起始类必须导入com.sun.javadoc。*并实现start(RootDoc)方法，如package description所述 。 如果doclet采用命令行选项，则还必须实现optionLength和validOptions 。

    支持自1.1之后添加的语言特性（如泛型和注释）的doclet应通过实现languageVersion来表明。 在没有这个的情况下，doclet不应该调用自1.5以来添加的任何Doclet API方法，并且修改了其他几种方法的结果，以便从doclet中隐藏新的结构（例如类型参数）。

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

    • 构造方法详细信息

      • Doclet

        public Doclet​()
        已过时。

    • 方法详细信息

      • start

        public static boolean start​(RootDoc root)
        已过时。
        在此生成文档。 所有doclet都需要此方法。
        参数
        root - 将RootDoc提供给方法。
        结果
        真正的成功。

      • optionLength

        public static int optionLength​(String option)
        已过时。
        检查doclet添加的选项。 返回必须在给定选项的命令行上指定的参数数。 例如，“-d docs”将返回2。

        如果doclet包含任何选项，则需要此方法。 如果缺少此方法，Javadoc将会为每个选项打印一个无效的标志错误。

        参数
        option - 返回争用次数的选项。
        结果
        在包含选项名称本身的选项的命令行上的参数数。 零返回意味着未知的选项。 负值表示发生错误。

      • validOptions

        public static boolean validOptions​(String[][] options,
                                   DocErrorReporter reporter)
        已过时。
        检查选项是否具有正确的参数。

        此方法不是必需的，但建议，因为如果此方法不存在，每个选项都将被视为有效。 如果缺席，它会默认默认（true）。

        打印选项相关的错误消息（使用提供的DocErrorReporter）是此方法的责任。

        参数
        options - 提供有效的选项作为字符串数组。
        reporter - 负责这些选项的DocErrorReporter。
        结果
        如果选项有效，则为true。

      • languageVersion

        public static LanguageVersion languageVersion​()
        已过时。
        返回此doclet支持的Java编程语言版本。

        任何支持语言版本比1.1更新的doclet都需要这种方法。

        结果
        该doclet支持的语言版本。
        从以下版本开始：
        1.5