Class HelpWriter


  • @Deprecated
    public class HelpWriter
    extends HtmlDocletWriter
    Deprecated.
    Generate the Help File for the generated API documentation. The help file contents are helpful for browsing the generated documentation.

    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
    • Constructor Detail

    • Method Detail

      • generate

        public static void generate​(ConfigurationImpl configuration)
        Deprecated.
        Construct the HelpWriter object and then use it to generate the help file. The name of the generated file is "help-doc.html". The help file will get generated if and only if "-helpfile" and "-nohelp" is not used on the command line.
        Throws:
        DocletAbortException
      • generateHelpFile

        protected void generateHelpFile()
                                 throws IOException
        Deprecated.
        Generate the help file contents.
        Throws:
        IOException
      • addHelpFileContents

        protected void addHelpFileContents​(Content contentTree)
        Deprecated.
        Add the help file contents from the resource file to the content tree. While adding the help file contents it also keeps track of user options. If "-notree" is used, then the "overview-tree.html" will not get added and hence help information also will not get added.
        Parameters:
        contentTree - the content tree to which the help file contents will be added