net.cscott.sinjdoc
public abstract class Doclet extends Object
Doclet class provides the entry-point methods for
a documentation generator.
Version: $Id: Doclet.java,v 1.3 2003/05/08 03:54:25 cananian Exp $
See Also: com.sun.javadoc.Doclet
| Method Summary | |
|---|---|
| String | getName() Return a short human-friendly string naming this Doclet. |
| void | optionHelp(DocErrorReporter reporter) Print help text describing the options accepted by this doclet.
|
| int | optionLength(String option) Check for doclet-added options here.
|
| abstract boolean | start(RootDoc root)
Generate documentation here. |
| boolean | validOptions(List<List<String>> options, DocErrorReporter reporter) Check that options have the correct arguments here.
|
This method is not required and will default gracefully (not printing anything) if absent.
Printing should be done using
reporter.printNotice(msg).
This method is not required and will default gracefully (to zero) if absent.
Returns: Number of arguments to option. Zero returns means option not known. Negative value means error occurred.
Returns: true on success.
This method is not required and will default gracefully (to true) if absent.
Printing option-related error messages (using the provided
DocErrorReporter is the responsibility of this method.
Returns: true if the options are valid.