jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlConstants.java@90af8d87741f

6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg

     1 /*

     2  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     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  */

    26 package com.sun.tools.doclets.formats.html.markup;

    28 import com.sun.tools.doclets.internal.toolkit.Content;

    30 /**

    31  * Stores constants for Html Doclet.

    32  *

    33  * @author Bhavesh Patel

    34  */

    35 public class HtmlConstants {

    37     /**

    38      * Marker to identify start of top navigation bar.

    39      */

    40     public static final Content START_OF_TOP_NAVBAR =

    41             new Comment("========= START OF TOP NAVBAR =======");

    43     /**

    44      * Marker to identify start of bottom navigation bar.

    45      */

    46     public static final Content START_OF_BOTTOM_NAVBAR =

    47             new Comment("======= START OF BOTTOM NAVBAR ======");

    49     /**

    50      * Marker to identify end of top navigation bar.

    51      */

    52     public static final Content END_OF_TOP_NAVBAR =

    53             new Comment("========= END OF TOP NAVBAR =========");

    55     /**

    56      * Marker to identify end of bottom navigation bar.

    57      */

    58     public static final Content END_OF_BOTTOM_NAVBAR =

    59             new Comment("======== END OF BOTTOM NAVBAR =======");

    61     /**

    62      * Marker to identify start of class data.

    63      */

    64     public static final Content START_OF_CLASS_DATA =

    65             new Comment("======== START OF CLASS DATA ========");

    67     /**

    68      * Marker to identify end of class data.

    69      */

    70     public static final Content END_OF_CLASS_DATA =

    71             new Comment("========= END OF CLASS DATA =========");

    73     /**

    74      * Marker to identify start of nested class summary.

    75      */

    76     public static final Content START_OF_NESTED_CLASS_SUMMARY =

    77             new Comment("======== NESTED CLASS SUMMARY ========");

    79     /**

    80      * Marker to identify start of annotation type optional member summary.

    81      */

    82     public static final Content START_OF_ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY =

    83             new Comment("=========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY ===========");

    85     /**

    86      * Marker to identify start of annotation type required member summary.

    87      */

    88     public static final Content START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY =

    89             new Comment("=========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY ===========");

    91     /**

    92      * Marker to identify start of constructor summary.

    93      */

    94     public static final Content START_OF_CONSTRUCTOR_SUMMARY =

    95             new Comment("======== CONSTRUCTOR SUMMARY ========");

    97     /**

    98      * Marker to identify start of enum constants summary.

    99      */

   100     public static final Content START_OF_ENUM_CONSTANT_SUMMARY =

   101             new Comment("=========== ENUM CONSTANT SUMMARY ===========");

   103     /**

   104      * Marker to identify start of field summary.

   105      */

   106     public static final Content START_OF_FIELD_SUMMARY =

   107             new Comment("=========== FIELD SUMMARY ===========");

   109     /**

   110      * Marker to identify start of method summary.

   111      */

   112     public static final Content START_OF_METHOD_SUMMARY =

   113             new Comment("========== METHOD SUMMARY ===========");

   115     /**

   116      * Marker to identify start of annotation type details.

   117      */

   118     public static final Content START_OF_ANNOTATION_TYPE_DETAILS =

   119             new Comment("============ ANNOTATION TYPE MEMBER DETAIL ===========");

   121     /**

   122      * Marker to identify start of method details.

   123      */

   124     public static final Content START_OF_METHOD_DETAILS =

   125             new Comment("============ METHOD DETAIL ==========");

   127     /**

   128      * Marker to identify start of field details.

   129      */

   130     public static final Content START_OF_FIELD_DETAILS =

   131             new Comment("============ FIELD DETAIL ===========");

   133     /**

   134      * Marker to identify start of constructor details.

   135      */

   136     public static final Content START_OF_CONSTRUCTOR_DETAILS =

   137             new Comment("========= CONSTRUCTOR DETAIL ========");

   139     /**

   140      * Marker to identify start of enum constants details.

   141      */

   142     public static final Content START_OF_ENUM_CONSTANT_DETAILS =

   143             new Comment("============ ENUM CONSTANT DETAIL ===========");

   145     /**

   146      * Html tag for the page title heading.

   147      */

   148     public static final HtmlTag TITLE_HEADING = HtmlTag.H1;

   150     /**

   151      * Html tag for the class page title heading.

   152      */

   153     public static final HtmlTag CLASS_PAGE_HEADING = HtmlTag.H2;

   155     /**

   156      * Html tag for the content heading.

   157      */

   158     public static final HtmlTag CONTENT_HEADING = HtmlTag.H2;

   160     /**

   161      * Html tag for the package name heading.

   162      */

   163     public static final HtmlTag PACKAGE_HEADING = HtmlTag.H2;

   165     /**

   166      * Html tag for the member summary heading.

   167      */

   168     public static final HtmlTag SUMMARY_HEADING = HtmlTag.H3;

   170     /**

   171      * Html tag for the inherited member summary heading.

   172      */

   173     public static final HtmlTag INHERITED_SUMMARY_HEADING = HtmlTag.H3;

   175     /**

   176      * Html tag for the member details heading.

   177      */

   178     public static final HtmlTag DETAILS_HEADING = HtmlTag.H3;

   180     /**

   181      * Html tag for the serialized member heading.

   182      */

   183     public static final HtmlTag SERIALIZED_MEMBER_HEADING = HtmlTag.H3;

   185     /**

   186      * Html tag for the member heading.

   187      */

   188     public static final HtmlTag MEMBER_HEADING = HtmlTag.H4;

   189 }

Mercurial > jdk8-mips64-public > langtools / file revision