Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlConstants.java@90af8d87741f (annotated)
src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlConstants.java
Wed, 01 Dec 2010 11:02:38 -0800
- author
- bpatel
- date
- Wed, 01 Dec 2010 11:02:38 -0800
- changeset 766
- 90af8d87741f
- child 1359
- 25e14ad23cef
- permissions
- -rw-r--r--
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg
| bpatel@766 | 1 | /* |
| bpatel@766 | 2 | * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. |
| bpatel@766 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| bpatel@766 | 4 | * |
| bpatel@766 | 5 | * This code is free software; you can redistribute it and/or modify it |
| bpatel@766 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| bpatel@766 | 7 | * published by the Free Software Foundation. Oracle designates this |
| bpatel@766 | 8 | * particular file as subject to the "Classpath" exception as provided |
| bpatel@766 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| bpatel@766 | 10 | * |
| bpatel@766 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| bpatel@766 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| bpatel@766 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| bpatel@766 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| bpatel@766 | 15 | * accompanied this code). |
| bpatel@766 | 16 | * |
| bpatel@766 | 17 | * You should have received a copy of the GNU General Public License version |
| bpatel@766 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| bpatel@766 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| bpatel@766 | 20 | * |
| bpatel@766 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| bpatel@766 | 22 | * or visit www.oracle.com if you need additional information or have any |
| bpatel@766 | 23 | * questions. |
| bpatel@766 | 24 | */ |
| bpatel@766 | 25 | |
| bpatel@766 | 26 | package com.sun.tools.doclets.formats.html.markup; |
| bpatel@766 | 27 | |
| bpatel@766 | 28 | import com.sun.tools.doclets.internal.toolkit.Content; |
| bpatel@766 | 29 | |
| bpatel@766 | 30 | /** |
| bpatel@766 | 31 | * Stores constants for Html Doclet. |
| bpatel@766 | 32 | * |
| bpatel@766 | 33 | * @author Bhavesh Patel |
| bpatel@766 | 34 | */ |
| bpatel@766 | 35 | public class HtmlConstants { |
| bpatel@766 | 36 | |
| bpatel@766 | 37 | /** |
| bpatel@766 | 38 | * Marker to identify start of top navigation bar. |
| bpatel@766 | 39 | */ |
| bpatel@766 | 40 | public static final Content START_OF_TOP_NAVBAR = |
| bpatel@766 | 41 | new Comment("========= START OF TOP NAVBAR ======="); |
| bpatel@766 | 42 | |
| bpatel@766 | 43 | /** |
| bpatel@766 | 44 | * Marker to identify start of bottom navigation bar. |
| bpatel@766 | 45 | */ |
| bpatel@766 | 46 | public static final Content START_OF_BOTTOM_NAVBAR = |
| bpatel@766 | 47 | new Comment("======= START OF BOTTOM NAVBAR ======"); |
| bpatel@766 | 48 | |
| bpatel@766 | 49 | /** |
| bpatel@766 | 50 | * Marker to identify end of top navigation bar. |
| bpatel@766 | 51 | */ |
| bpatel@766 | 52 | public static final Content END_OF_TOP_NAVBAR = |
| bpatel@766 | 53 | new Comment("========= END OF TOP NAVBAR ========="); |
| bpatel@766 | 54 | |
| bpatel@766 | 55 | /** |
| bpatel@766 | 56 | * Marker to identify end of bottom navigation bar. |
| bpatel@766 | 57 | */ |
| bpatel@766 | 58 | public static final Content END_OF_BOTTOM_NAVBAR = |
| bpatel@766 | 59 | new Comment("======== END OF BOTTOM NAVBAR ======="); |
| bpatel@766 | 60 | |
| bpatel@766 | 61 | /** |
| bpatel@766 | 62 | * Marker to identify start of class data. |
| bpatel@766 | 63 | */ |
| bpatel@766 | 64 | public static final Content START_OF_CLASS_DATA = |
| bpatel@766 | 65 | new Comment("======== START OF CLASS DATA ========"); |
| bpatel@766 | 66 | |
| bpatel@766 | 67 | /** |
| bpatel@766 | 68 | * Marker to identify end of class data. |
| bpatel@766 | 69 | */ |
| bpatel@766 | 70 | public static final Content END_OF_CLASS_DATA = |
| bpatel@766 | 71 | new Comment("========= END OF CLASS DATA ========="); |
| bpatel@766 | 72 | |
| bpatel@766 | 73 | /** |
| bpatel@766 | 74 | * Marker to identify start of nested class summary. |
| bpatel@766 | 75 | */ |
| bpatel@766 | 76 | public static final Content START_OF_NESTED_CLASS_SUMMARY = |
| bpatel@766 | 77 | new Comment("======== NESTED CLASS SUMMARY ========"); |
| bpatel@766 | 78 | |
| bpatel@766 | 79 | /** |
| bpatel@766 | 80 | * Marker to identify start of annotation type optional member summary. |
| bpatel@766 | 81 | */ |
| bpatel@766 | 82 | public static final Content START_OF_ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY = |
| bpatel@766 | 83 | new Comment("=========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY ==========="); |
| bpatel@766 | 84 | |
| bpatel@766 | 85 | /** |
| bpatel@766 | 86 | * Marker to identify start of annotation type required member summary. |
| bpatel@766 | 87 | */ |
| bpatel@766 | 88 | public static final Content START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY = |
| bpatel@766 | 89 | new Comment("=========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY ==========="); |
| bpatel@766 | 90 | |
| bpatel@766 | 91 | /** |
| bpatel@766 | 92 | * Marker to identify start of constructor summary. |
| bpatel@766 | 93 | */ |
| bpatel@766 | 94 | public static final Content START_OF_CONSTRUCTOR_SUMMARY = |
| bpatel@766 | 95 | new Comment("======== CONSTRUCTOR SUMMARY ========"); |
| bpatel@766 | 96 | |
| bpatel@766 | 97 | /** |
| bpatel@766 | 98 | * Marker to identify start of enum constants summary. |
| bpatel@766 | 99 | */ |
| bpatel@766 | 100 | public static final Content START_OF_ENUM_CONSTANT_SUMMARY = |
| bpatel@766 | 101 | new Comment("=========== ENUM CONSTANT SUMMARY ==========="); |
| bpatel@766 | 102 | |
| bpatel@766 | 103 | /** |
| bpatel@766 | 104 | * Marker to identify start of field summary. |
| bpatel@766 | 105 | */ |
| bpatel@766 | 106 | public static final Content START_OF_FIELD_SUMMARY = |
| bpatel@766 | 107 | new Comment("=========== FIELD SUMMARY ==========="); |
| bpatel@766 | 108 | |
| bpatel@766 | 109 | /** |
| bpatel@766 | 110 | * Marker to identify start of method summary. |
| bpatel@766 | 111 | */ |
| bpatel@766 | 112 | public static final Content START_OF_METHOD_SUMMARY = |
| bpatel@766 | 113 | new Comment("========== METHOD SUMMARY ==========="); |
| bpatel@766 | 114 | |
| bpatel@766 | 115 | /** |
| bpatel@766 | 116 | * Marker to identify start of annotation type details. |
| bpatel@766 | 117 | */ |
| bpatel@766 | 118 | public static final Content START_OF_ANNOTATION_TYPE_DETAILS = |
| bpatel@766 | 119 | new Comment("============ ANNOTATION TYPE MEMBER DETAIL ==========="); |
| bpatel@766 | 120 | |
| bpatel@766 | 121 | /** |
| bpatel@766 | 122 | * Marker to identify start of method details. |
| bpatel@766 | 123 | */ |
| bpatel@766 | 124 | public static final Content START_OF_METHOD_DETAILS = |
| bpatel@766 | 125 | new Comment("============ METHOD DETAIL =========="); |
| bpatel@766 | 126 | |
| bpatel@766 | 127 | /** |
| bpatel@766 | 128 | * Marker to identify start of field details. |
| bpatel@766 | 129 | */ |
| bpatel@766 | 130 | public static final Content START_OF_FIELD_DETAILS = |
| bpatel@766 | 131 | new Comment("============ FIELD DETAIL ==========="); |
| bpatel@766 | 132 | |
| bpatel@766 | 133 | /** |
| bpatel@766 | 134 | * Marker to identify start of constructor details. |
| bpatel@766 | 135 | */ |
| bpatel@766 | 136 | public static final Content START_OF_CONSTRUCTOR_DETAILS = |
| bpatel@766 | 137 | new Comment("========= CONSTRUCTOR DETAIL ========"); |
| bpatel@766 | 138 | |
| bpatel@766 | 139 | /** |
| bpatel@766 | 140 | * Marker to identify start of enum constants details. |
| bpatel@766 | 141 | */ |
| bpatel@766 | 142 | public static final Content START_OF_ENUM_CONSTANT_DETAILS = |
| bpatel@766 | 143 | new Comment("============ ENUM CONSTANT DETAIL ==========="); |
| bpatel@766 | 144 | |
| bpatel@766 | 145 | /** |
| bpatel@766 | 146 | * Html tag for the page title heading. |
| bpatel@766 | 147 | */ |
| bpatel@766 | 148 | public static final HtmlTag TITLE_HEADING = HtmlTag.H1; |
| bpatel@766 | 149 | |
| bpatel@766 | 150 | /** |
| bpatel@766 | 151 | * Html tag for the class page title heading. |
| bpatel@766 | 152 | */ |
| bpatel@766 | 153 | public static final HtmlTag CLASS_PAGE_HEADING = HtmlTag.H2; |
| bpatel@766 | 154 | |
| bpatel@766 | 155 | /** |
| bpatel@766 | 156 | * Html tag for the content heading. |
| bpatel@766 | 157 | */ |
| bpatel@766 | 158 | public static final HtmlTag CONTENT_HEADING = HtmlTag.H2; |
| bpatel@766 | 159 | |
| bpatel@766 | 160 | /** |
| bpatel@766 | 161 | * Html tag for the package name heading. |
| bpatel@766 | 162 | */ |
| bpatel@766 | 163 | public static final HtmlTag PACKAGE_HEADING = HtmlTag.H2; |
| bpatel@766 | 164 | |
| bpatel@766 | 165 | /** |
| bpatel@766 | 166 | * Html tag for the member summary heading. |
| bpatel@766 | 167 | */ |
| bpatel@766 | 168 | public static final HtmlTag SUMMARY_HEADING = HtmlTag.H3; |
| bpatel@766 | 169 | |
| bpatel@766 | 170 | /** |
| bpatel@766 | 171 | * Html tag for the inherited member summary heading. |
| bpatel@766 | 172 | */ |
| bpatel@766 | 173 | public static final HtmlTag INHERITED_SUMMARY_HEADING = HtmlTag.H3; |
| bpatel@766 | 174 | |
| bpatel@766 | 175 | /** |
| bpatel@766 | 176 | * Html tag for the member details heading. |
| bpatel@766 | 177 | */ |
| bpatel@766 | 178 | public static final HtmlTag DETAILS_HEADING = HtmlTag.H3; |
| bpatel@766 | 179 | |
| bpatel@766 | 180 | /** |
| bpatel@766 | 181 | * Html tag for the serialized member heading. |
| bpatel@766 | 182 | */ |
| bpatel@766 | 183 | public static final HtmlTag SERIALIZED_MEMBER_HEADING = HtmlTag.H3; |
| bpatel@766 | 184 | |
| bpatel@766 | 185 | /** |
| bpatel@766 | 186 | * Html tag for the member heading. |
| bpatel@766 | 187 | */ |
| bpatel@766 | 188 | public static final HtmlTag MEMBER_HEADING = HtmlTag.H4; |
| bpatel@766 | 189 | } |
