| java.lang.Object com.sun.tools.doclets.internal.toolkit.AbstractDoclet
All known Subclasses: com.sun.tools.doclets.formats.html.HtmlDoclet,
AbstractDoclet | abstract public class AbstractDoclet (Code) | | An abstract implementation of a Doclet.
This code is not part of an API.
It is implementation that is subject to change.
Do not use it as an API.
author: Jamie Ho |
Method Summary | |
abstract public Configuration | configuration() Create the configuration instance and returns it. | abstract protected void | generateClassFiles(ClassDoc[] arr, ClassTree classtree) Generate the class documentation. | protected void | generateClassFiles(RootDoc root, ClassTree classtree) Iterate through all classes and construct documentation for them. | protected void | generateOtherFiles(RootDoc root, ClassTree classtree) Generate additional documentation that is added to the API documentation. | abstract protected void | generatePackageFiles(ClassTree classtree) Generate the package documentation. | public static LanguageVersion | languageVersion() Indicate that this doclet supports the 1.5 language features. | public boolean | start(AbstractDoclet doclet, RootDoc root) The method that starts the execution of the doclet.
Parameters: doclet - the doclet to start the execution for. Parameters: root - the RootDoc that points to the source to document. |
configuration | public Configuration configuration(Code) | | The global configuration information for this run.
|
configuration | abstract public Configuration configuration()(Code) | | Create the configuration instance and returns it.
the configuration of the doclet. |
generateClassFiles | abstract protected void generateClassFiles(ClassDoc[] arr, ClassTree classtree)(Code) | | Generate the class documentation.
Parameters: classtree - the data structure representing the class tree. |
generateClassFiles | protected void generateClassFiles(RootDoc root, ClassTree classtree)(Code) | | Iterate through all classes and construct documentation for them.
Parameters: root - the RootDoc of source to document. Parameters: classtree - the data structure representing the class tree. |
generateOtherFiles | protected void generateOtherFiles(RootDoc root, ClassTree classtree) throws Exception(Code) | | Generate additional documentation that is added to the API documentation.
Parameters: root - the RootDoc of source to document. Parameters: classtree - the data structure representing the class tree. |
generatePackageFiles | abstract protected void generatePackageFiles(ClassTree classtree) throws Exception(Code) | | Generate the package documentation.
Parameters: classtree - the data structure representing the class tree. |
languageVersion | public static LanguageVersion languageVersion()(Code) | | Indicate that this doclet supports the 1.5 language features.
JAVA_1_5, indicating that the new features are supported. |
start | public boolean start(AbstractDoclet doclet, RootDoc root)(Code) | | The method that starts the execution of the doclet.
Parameters: doclet - the doclet to start the execution for. Parameters: root - the RootDoc that points to the source to document. true if the doclet executed without error. False otherwise. |
|
|