Package gw.gosudoc.com.sun.tools.doclets.formats.html

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.

  • Field Details

    • docletToStart

      private static HtmlDoclet docletToStart
      Deprecated.

    • configuration

      public final ConfigurationImpl configuration
      Deprecated.
      The global configuration information for this run.

    • sharedInstanceForOptions

      public static final ConfigurationImpl sharedInstanceForOptions
      Deprecated.

  • Constructor Details

    • HtmlDoclet

      public HtmlDoclet()
      Deprecated.

  • Method Details

    • 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:

    • configuration

      public Configuration configuration()
      Deprecated.
      Create the configuration instance. Override this method to use a different configuration.
      Specified by:
      configuration in class AbstractDoclet
      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 class AbstractDoclet
      Parameters:
      root - the RootDoc of source to document.
      classtree - the data structure representing the class tree.
      Throws:
      Exception
      See Also:

    • copyJqueryFiles

      protected void copyJqueryFiles()
      Deprecated.

    • generateClassFiles

      protected void generateClassFiles(ClassDoc[] arr, ClassTree classtree)
      Deprecated.
      Generate the class documentation.
      Specified by:
      generateClassFiles in class AbstractDoclet
      classtree - the data structure representing the class tree.

    • getNamedPackage

      PackageDoc getNamedPackage(List<PackageDoc> list, int idx)
      Deprecated.

    • generatePackageFiles

      protected void generatePackageFiles(ClassTree classtree) throws Exception
      Deprecated.
      Generate the package documentation.
      Specified by:
      generatePackageFiles in class AbstractDoclet
      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.

    • performCopy

      private void performCopy(String filename)
      Deprecated.