| java.lang.Object
 com.sun.tools.doclets.internal.toolkit.AbstractDoclet
com.sun.tools.doclets.formats.html.HtmlDoclet
| HtmlDoclet | | public class HtmlDoclet extends AbstractDoclet (Code) | | The class with "start" method, calls individual Writers.
author:
Atul M Dambalkar
author:
Robert Field
author:
Jamie Ho |
| configuration | | public Configuration configuration()(Code) | | Create the configuration instance.
Override this method to use a different
configuration.
|
| generateClassFiles | | protected void generateClassFiles(ClassDoc[] arr, ClassTree classtree)(Code) | | |
| generateOtherFiles | | protected void generateOtherFiles(RootDoc root, ClassTree classtree) throws Exception(Code) | | 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.
See Also: com.sun.javadoc.RootDoc |
| optionLength | | public static int optionLength(String option)(Code) | | Check for doclet added options here.
number of arguments to option. Zero return meansoption not known. Negative value means error occurred. |
| start | | public static boolean start(RootDoc root)(Code) | | The "start" method as required by Javadoc.
Parameters:
root - the root of the documentation tree.
See Also: com.sun.javadoc.RootDoc true if the doclet ran without encountering any errors. |
| validOptions | | public static boolean validOptions(String options, DocErrorReporter reporter)(Code) | | 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.
true if the options are valid. |
|
|