com.aurigalogic.doclet.core
Class Doclet

java.lang.Object
  |
  +--com.sun.javadoc.Doclet
        |
        +--com.aurigalogic.doclet.core.Doclet

public class Doclet

extends com.sun.javadoc.Doclet

Doclet class for AurigaDoclet

Version:

$Revision: 1.1 $ $Date: 2003/12/24 12:41:39 $

Author:

Khurshidali Shaikh

See Also:

Serialized Form

Field Summary

protected static java.lang.String	BOTTOM_MARGIN
protected static java.lang.String	COVER_FILE
protected static java.lang.String	COVER_TEXT
protected static java.lang.String	CSS_FILE
protected static java.lang.String	FOOTER_FILE
protected static java.lang.String	FOOTER_HEIGHT
protected static java.lang.String	FOOTER_TEXT
protected static java.lang.String	FORMAT
protected static java.lang.String	HEADER_FILE
protected static java.lang.String	HEADER_HEIGHT
protected static java.lang.String	HEADER_TEXT
protected static java.lang.String	LEFT_MARGIN
protected static java.lang.String	NO_INDEX
protected static java.lang.String	NO_LINKS
protected static java.lang.String	NO_NAVIGATION
protected static java.lang.String	NO_TOC
protected static java.lang.String	OUTPUT
protected static java.lang.String	RIGHT_MARGIN
protected static java.lang.String	TOP_MARGIN
protected static java.lang.String	XSL_FILE

Constructor Summary

Doclet(java.lang.String[][] options)
Default constructor.

Method Summary

static int	optionLength(java.lang.String option) Returns the option length for supported command line options.
static boolean	start(RootDoc rootDoc) Entry point for this doclet.
static boolean	validOptions(java.lang.String[][] options, DocErrorReporter reporter) Validates the options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_LINKS

protected static final java.lang.String NO_LINKS

See Also:

Constant Field Values

NO_INDEX

protected static final java.lang.String NO_INDEX

See Also:

Constant Field Values

NO_TOC

protected static final java.lang.String NO_TOC

See Also:

Constant Field Values

NO_NAVIGATION

protected static final java.lang.String NO_NAVIGATION

See Also:

Constant Field Values

HEADER_TEXT

protected static final java.lang.String HEADER_TEXT

See Also:

Constant Field Values

HEADER_HEIGHT

protected static final java.lang.String HEADER_HEIGHT

See Also:

Constant Field Values

FOOTER_TEXT

protected static final java.lang.String FOOTER_TEXT

See Also:

Constant Field Values

FOOTER_HEIGHT

protected static final java.lang.String FOOTER_HEIGHT

See Also:

Constant Field Values

HEADER_FILE

protected static final java.lang.String HEADER_FILE

See Also:

Constant Field Values

FOOTER_FILE

protected static final java.lang.String FOOTER_FILE

See Also:

Constant Field Values

COVER_TEXT

protected static final java.lang.String COVER_TEXT

See Also:

Constant Field Values

COVER_FILE

protected static final java.lang.String COVER_FILE

See Also:

Constant Field Values

CSS_FILE

protected static final java.lang.String CSS_FILE

See Also:

Constant Field Values

XSL_FILE

protected static final java.lang.String XSL_FILE

See Also:

Constant Field Values

FORMAT

protected static final java.lang.String FORMAT

See Also:

Constant Field Values

OUTPUT

protected static final java.lang.String OUTPUT

See Also:

Constant Field Values

LEFT_MARGIN

protected static final java.lang.String LEFT_MARGIN

See Also:

Constant Field Values

RIGHT_MARGIN

protected static final java.lang.String RIGHT_MARGIN

See Also:

Constant Field Values

TOP_MARGIN

protected static final java.lang.String TOP_MARGIN

See Also:

Constant Field Values

BOTTOM_MARGIN

protected static final java.lang.String BOTTOM_MARGIN

See Also:

Constant Field Values

Constructor Detail

Doclet

public Doclet(java.lang.String[][] options)

Default constructor.

Method Detail

start

public static boolean start(RootDoc rootDoc)

Entry point for this doclet.

optionLength

public static int optionLength(java.lang.String option)

Returns the option length for supported command line options.

validOptions

public static boolean validOptions(java.lang.String[][] options,
                                   DocErrorReporter reporter)

Validates the options.