Class AbstractDoclet
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.AbstractDoclet
- Direct Known Subclasses:
HtmlDoclet
Deprecated.
An abstract implementation of a Doclet.
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.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract Configuration
Deprecated.Create the configuration instance and returns it.protected abstract void
generateClassFiles
(ClassDoc[] arr, ClassTree classtree) Deprecated.Generate the class documentation.protected void
generateClassFiles
(RootDoc root, ClassTree classtree) Deprecated.Iterate through all classes and construct documentation for them.private void
generateClassFiles
(ClassTree classtree) Deprecated.Generate the class files for single classes specified on the command line.protected void
generateOtherFiles
(RootDoc root, ClassTree classtree) Deprecated.Generate additional documentation that is added to the API documentation.protected abstract void
generatePackageFiles
(ClassTree classtree) Deprecated.Generate the package documentation.private boolean
Deprecated.Verify that the only doclet that is using this toolkit is .static LanguageVersion
Deprecated.Indicate that this doclet supports the 1.5 language features.boolean
startDoclet
(RootDoc root) Deprecated.The method that starts the execution of the doclet.private void
startGeneration
(RootDoc root) Deprecated.Start the generation of files.
-
Field Details
-
configuration
Deprecated.The global configuration information for this run. -
utils
Deprecated. -
TOOLKIT_DOCLET_NAME
Deprecated.The only doclet that may use this toolkit is
-
-
Constructor Details
-
AbstractDoclet
public AbstractDoclet()Deprecated.
-
-
Method Details
-
isValidDoclet
private boolean isValidDoclet()Deprecated.Verify that the only doclet that is using this toolkit is . -
startDoclet
Deprecated.The method that starts the execution of the doclet.- Parameters:
root
- theRootDoc
that points to the source to document.- Returns:
- true if the doclet executed without error. False otherwise.
-
languageVersion
Deprecated.Indicate that this doclet supports the 1.5 language features.- Returns:
- JAVA_1_5, indicating that the new features are supported.
-
configuration
Deprecated.Create the configuration instance and returns it.- Returns:
- the configuration of the doclet.
-
startGeneration
Deprecated.Start the generation of files. Call generate methods in the individual writers, which will in turn generate 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.- Throws:
Configuration.Fault
Exception
- See Also:
-
generateOtherFiles
Deprecated.Generate additional documentation that is added to the API documentation.- Parameters:
root
- the RootDoc of source to document.classtree
- the data structure representing the class tree.- Throws:
Exception
-
generatePackageFiles
Deprecated.Generate the package documentation.- Parameters:
classtree
- the data structure representing the class tree.- Throws:
Exception
-
generateClassFiles
Deprecated.Generate the class documentation.- Parameters:
classtree
- the data structure representing the class tree.
-
generateClassFiles
Deprecated.Iterate through all classes and construct documentation for them.- Parameters:
root
- the RootDoc of source to document.classtree
- the data structure representing the class tree.
-
generateClassFiles
Deprecated.Generate the class files for single classes specified on the command line.- Parameters:
classtree
- the data structure representing the class tree.
-