Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS

Class sun.tools.javadoc.Doclet

java.lang.Object
    |
    +----sun.tools.javadoc.Doclet

public abstract class Doclet
extends java.lang.Object
This class documents the 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(java.lang.String option)
Check for doclet added options here.
static boolean  start(Root root)
Generate documentation here.
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Doclet

public Doclet()
Method Detail

start

public static boolean start(Root root)
Generate documentation here.
Returns:
true on success.

optionLength

public static int optionLength(java.lang.String option)
Check for doclet added options here. This method is not required.
Returns:
number of arguments to option. Zero return means option not known. Negative value means error occurred.

Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS