|
Doclet API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.javadoc.Doclet
This class documents the entry-point methods in a Doclet. It may be used as the superclass of a doclet but this is not required.
Constructor Summary | |
Doclet()
|
Method Summary | |
static int |
optionLength(String option)
Check for doclet added options here. |
static boolean |
start(RootDoc root)
Generate documentation here. |
static boolean |
validOptions(String[][] options,
DocErrorReporter reporter)
Check that options have the correct arguments here. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Doclet()
Method Detail |
public static boolean start(RootDoc root)
public static int optionLength(String option)
This method is not required and will default gracefully (to zero) if absent.
public static boolean validOptions(String[][] options, DocErrorReporter reporter)
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.
|
Doclet API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |