com.sun.tools.doclets.formats.html
Class HtmlDoclet

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.AbstractDoclet
      com.sun.tools.doclets.formats.html.HtmlDoclet

public class HtmlDoclet
extends AbstractDoclet

The class with "start" method, calls individual Writers.

Field Summary

ConfigurationImpl

configuration The global configuration information for this run.

Constructor Summary

HtmlDoclet()

Method Summary

Configuration	configuration() Create the configuration instance.
protected void	generateClassFiles(ClassDoc[] arr, ClassTree classtree) Generate the class documentation.
protected void	generateOtherFiles(RootDoc root, ClassTree classtree) Start the generation of files.
protected void	generatePackageFiles(ClassTree classtree) Generate the package documentation.
static int	optionLength(java.lang.String option) Check for doclet added options here.
private void	performCopy(java.lang.String configdestdir, java.lang.String filename)
static boolean	start(RootDoc root) The "start" method as required by Javadoc.
static boolean	validOptions(java.lang.String[][] options, DocErrorReporter reporter) Check that options have the correct arguments here.

Methods inherited from class com.sun.tools.doclets.internal.toolkit.AbstractDoclet

generateClassFiles, languageVersion, start

Methods inherited from class java.lang.Object

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

Field Detail

configuration

public ConfigurationImpl configuration

The global configuration information for this run.

Constructor Detail

HtmlDoclet

public HtmlDoclet()

Method Detail

start

public static boolean start(RootDoc root)

The "start" method as required by Javadoc.

Parameters:

root - the root of the documentation tree.

Returns:

true if the doclet ran without encountering any errors.

See Also:

RootDoc

configuration

public Configuration configuration()

Create the configuration instance. Override this method to use a different configuration.

Specified by:

configuration in class AbstractDoclet

Returns:

the configuration of the doclet.

generateOtherFiles

protected void generateOtherFiles(RootDoc root,
                                  ClassTree classtree)
                           throws java.lang.Exception

Start the generation of files. Call generate methods in the individual writers, which will in turn genrate the documentation files. Call the TreeWriter generation first to ensure the Class Hierarchy is built first and then can be used in the later generation. For new format.

Overrides:

generateOtherFiles in class AbstractDoclet

Parameters:

root - the RootDoc of source to document.

classtree - the data structure representing the class tree.

Throws:

java.lang.Exception

See Also:

RootDoc

generateClassFiles

protected void generateClassFiles(ClassDoc[] arr,
                                  ClassTree classtree)

Generate the class documentation.

Specified by:

generateClassFiles in class AbstractDoclet

classtree - the data structure representing the class tree.

generatePackageFiles

protected void generatePackageFiles(ClassTree classtree)
                             throws java.lang.Exception

Generate the package documentation.

Specified by:

generatePackageFiles in class AbstractDoclet

Parameters:

classtree - the data structure representing the class tree.

Throws:

java.lang.Exception

optionLength

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

Check for doclet added options here.

Returns:

number of arguments to option. Zero return means option not known. Negative value means error occurred.

validOptions

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

Check that options have the correct arguments here.

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.

performCopy

private void performCopy(java.lang.String configdestdir,
                         java.lang.String filename)