Class AbstractDoclet
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.AbstractDoclet
-
- Direct Known Subclasses:
HtmlDoclet
@Deprecated public abstract class AbstractDoclet extends Object
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.
- Author:
- Jamie Ho
-
-
Field Summary
Fields Modifier and Type Field Description Configuration
configuration
Deprecated.The global configuration information for this run.protected Utils
utils
Deprecated.
-
Constructor Summary
Constructors Constructor Description AbstractDoclet()
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract Configuration
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.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.static LanguageVersion
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.
-
-
-
Field Detail
-
configuration
public Configuration configuration
Deprecated.The global configuration information for this run.
-
utils
protected Utils utils
Deprecated.
-
-
Method Detail
-
startDoclet
public boolean startDoclet(RootDoc root)
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
public static LanguageVersion languageVersion()
Deprecated.Indicate that this doclet supports the 1.5 language features.- Returns:
- JAVA_1_5, indicating that the new features are supported.
-
configuration
public abstract Configuration configuration()
Deprecated.Create the configuration instance and returns it.- Returns:
- the configuration of the doclet.
-
generateOtherFiles
protected void generateOtherFiles(RootDoc root, ClassTree classtree) throws Exception
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
protected abstract void generatePackageFiles(ClassTree classtree) throws Exception
Deprecated.Generate the package documentation.- Parameters:
classtree
- the data structure representing the class tree.- Throws:
Exception
-
generateClassFiles
protected abstract void generateClassFiles(ClassDoc[] arr, ClassTree classtree)
Deprecated.Generate the class documentation.- Parameters:
classtree
- the data structure representing the class tree.
-
-