public abstract class Doclet extends Object
start(RootDoc)method, as described in the package description. If the doclet takes command line options, it must also implement
A doclet supporting the language features added since 1.1
(such as generics and annotations) should indicate this
languageVersion. In the absence of
this the doclet should not invoke any of the Doclet API methods
added since 1.5, and
the results of several other methods are modified so as
to conceal the new constructs (such as type parameters) from
To start the doclet, pass
-doclet followed by the fully-qualified
name of the starting class on the javadoc tool command line.
|Constructor and Description|
|Modifier and Type||Method and Description|
Return the version of the Java Programming Language supported by this doclet.
Check for doclet-added options.
Generate documentation here.
Check that options have the correct arguments.
public static boolean start(RootDoc root)
public static int optionLength(String option)
This method is required if the doclet contains any options. If this method is missing, Javadoc will print an invalid flag error for every option.
public static boolean validOptions(String options, DocErrorReporter reporter)
This method is not required, but is recommended, as every option will be considered valid if this method is not present. It will default gracefully (to true) if absent.
Printing option related error messages (using the provided DocErrorReporter) is the responsibility of this method.
public static LanguageVersion languageVersion()
This method is required by any doclet supporting a language version newer than 1.1.
Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.