src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HelpWriter.java

Print this page




   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.tools.doclets.formats.html;
  27 
  28 import java.io.*;
  29 
  30 import com.sun.tools.doclets.formats.html.markup.*;
  31 import com.sun.tools.doclets.internal.toolkit.*;
  32 import com.sun.tools.doclets.internal.toolkit.util.*;






  33 

  34 /**
  35  * Generate the Help File for the generated API documentation. The help file
  36  * contents are helpful for browsing the generated documentation.
  37  *
  38  *  <p><b>This is NOT part of any supported API.
  39  *  If you write code that depends on this, you do so at your own risk.
  40  *  This code and its internal interfaces are subject to change or
  41  *  deletion without notice.</b>
  42  *
  43  * @author Atul M Dambalkar
  44  */
  45 public class HelpWriter extends HtmlDocletWriter {
  46 
  47     HtmlTree mainTree = HtmlTree.MAIN();
  48 
  49     /**
  50      * Constructor to construct HelpWriter object.
  51      * @param filename File to be generated.
  52      */
  53     public HelpWriter(ConfigurationImpl configuration,




   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.javadoc.internal.doclets.formats.html;
  27 
  28 import java.io.*;
  29 
  30 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
  31 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
  32 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
  33 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
  34 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
  35 import jdk.javadoc.internal.doclets.toolkit.Content;
  36 import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
  37 import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
  38 import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
  39 
  40 
  41 /**
  42  * Generate the Help File for the generated API documentation. The help file
  43  * contents are helpful for browsing the generated documentation.
  44  *
  45  *  <p><b>This is NOT part of any supported API.
  46  *  If you write code that depends on this, you do so at your own risk.
  47  *  This code and its internal interfaces are subject to change or
  48  *  deletion without notice.</b>
  49  *
  50  * @author Atul M Dambalkar
  51  */
  52 public class HelpWriter extends HtmlDocletWriter {
  53 
  54     HtmlTree mainTree = HtmlTree.MAIN();
  55 
  56     /**
  57      * Constructor to construct HelpWriter object.
  58      * @param filename File to be generated.
  59      */
  60     public HelpWriter(ConfigurationImpl configuration,