Class HtmlDoclet
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.AbstractDoclet
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDoclet
-
@Deprecated public class HtmlDoclet extends AbstractDoclet
Deprecated.The class with "start" method, calls individual Writers.This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Author:
- Atul M Dambalkar, Robert Field, Jamie Ho
-
-
Field Summary
Fields Modifier and Type Field Description ConfigurationImpl
configuration
Deprecated.The global configuration information for this run.static ConfigurationImpl
sharedInstanceForOptions
Deprecated.-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.AbstractDoclet
utils
-
-
Constructor Summary
Constructors Constructor Description HtmlDoclet()
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Configuration
configuration()
Deprecated.Create the configuration instance.protected void
copyJqueryFiles()
Deprecated.protected void
generateClassFiles(ClassDoc[] arr, ClassTree classtree)
Deprecated.Generate the class documentation.protected void
generateOtherFiles(RootDoc root, ClassTree classtree)
Deprecated.Start the generation of files.protected void
generatePackageFiles(ClassTree classtree)
Deprecated.Generate the package documentation.static int
optionLength(String option)
Deprecated.Check for doclet added options here.static boolean
start(RootDoc root)
Deprecated.The "start" method as required by Javadoc.static boolean
validOptions(String[][] options, DocErrorReporter reporter)
Deprecated.Check that options have the correct arguments here.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.AbstractDoclet
generateClassFiles, languageVersion, startDoclet
-
-
-
-
Field Detail
-
configuration
public final ConfigurationImpl configuration
Deprecated.The global configuration information for this run.
-
sharedInstanceForOptions
public static final ConfigurationImpl sharedInstanceForOptions
Deprecated.
-
-
Method Detail
-
start
public static boolean start(RootDoc root)
Deprecated.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()
Deprecated.Create the configuration instance. Override this method to use a different configuration.- Specified by:
configuration
in classAbstractDoclet
- Returns:
- the configuration of the doclet.
-
generateOtherFiles
protected void generateOtherFiles(RootDoc root, ClassTree classtree) throws Exception
Deprecated.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 classAbstractDoclet
- Parameters:
root
- the RootDoc of source to document.classtree
- the data structure representing the class tree.- Throws:
Exception
- See Also:
RootDoc
-
copyJqueryFiles
protected void copyJqueryFiles()
Deprecated.
-
generateClassFiles
protected void generateClassFiles(ClassDoc[] arr, ClassTree classtree)
Deprecated.Generate the class documentation.- Specified by:
generateClassFiles
in classAbstractDoclet
classtree
- the data structure representing the class tree.
-
generatePackageFiles
protected void generatePackageFiles(ClassTree classtree) throws Exception
Deprecated.Generate the package documentation.- Specified by:
generatePackageFiles
in classAbstractDoclet
- Parameters:
classtree
- the data structure representing the class tree.- Throws:
Exception
-
optionLength
public static int optionLength(String option)
Deprecated.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(String[][] options, DocErrorReporter reporter)
Deprecated.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.
-
-