src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlConstants.java

Sun, 24 Feb 2013 11:36:58 -0800

author
jjg
date
Sun, 24 Feb 2013 11:36:58 -0800
changeset 1606
ccbe7ffdd867
parent 1568
5f0731e4e5e6
child 2035
a2a5ad0853ed
permissions
-rw-r--r--

7112427: The doclet needs to be able to generate JavaFX documentation.
Reviewed-by: jjg
Contributed-by: jan.valenta@oracle.com

bpatel@766 1 /*
bpatel@1568 2 * Copyright (c) 2010, 2013, 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 *
jjg@1359 33 * <p><b>This is NOT part of any supported API.
jjg@1359 34 * If you write code that depends on this, you do so at your own risk.
jjg@1359 35 * This code and its internal interfaces are subject to change or
jjg@1359 36 * deletion without notice.</b>
jjg@1359 37 *
bpatel@766 38 * @author Bhavesh Patel
bpatel@766 39 */
bpatel@766 40 public class HtmlConstants {
bpatel@766 41
bpatel@766 42 /**
bpatel@766 43 * Marker to identify start of top navigation bar.
bpatel@766 44 */
bpatel@766 45 public static final Content START_OF_TOP_NAVBAR =
bpatel@766 46 new Comment("========= START OF TOP NAVBAR =======");
bpatel@766 47
bpatel@766 48 /**
bpatel@766 49 * Marker to identify start of bottom navigation bar.
bpatel@766 50 */
bpatel@766 51 public static final Content START_OF_BOTTOM_NAVBAR =
bpatel@766 52 new Comment("======= START OF BOTTOM NAVBAR ======");
bpatel@766 53
bpatel@766 54 /**
bpatel@766 55 * Marker to identify end of top navigation bar.
bpatel@766 56 */
bpatel@766 57 public static final Content END_OF_TOP_NAVBAR =
bpatel@766 58 new Comment("========= END OF TOP NAVBAR =========");
bpatel@766 59
bpatel@766 60 /**
bpatel@766 61 * Marker to identify end of bottom navigation bar.
bpatel@766 62 */
bpatel@766 63 public static final Content END_OF_BOTTOM_NAVBAR =
bpatel@766 64 new Comment("======== END OF BOTTOM NAVBAR =======");
bpatel@766 65
bpatel@766 66 /**
bpatel@766 67 * Marker to identify start of class data.
bpatel@766 68 */
bpatel@766 69 public static final Content START_OF_CLASS_DATA =
bpatel@766 70 new Comment("======== START OF CLASS DATA ========");
bpatel@766 71
bpatel@766 72 /**
bpatel@766 73 * Marker to identify end of class data.
bpatel@766 74 */
bpatel@766 75 public static final Content END_OF_CLASS_DATA =
bpatel@766 76 new Comment("========= END OF CLASS DATA =========");
bpatel@766 77
bpatel@766 78 /**
bpatel@766 79 * Marker to identify start of nested class summary.
bpatel@766 80 */
bpatel@766 81 public static final Content START_OF_NESTED_CLASS_SUMMARY =
bpatel@766 82 new Comment("======== NESTED CLASS SUMMARY ========");
bpatel@766 83
bpatel@766 84 /**
bpatel@766 85 * Marker to identify start of annotation type optional member summary.
bpatel@766 86 */
bpatel@766 87 public static final Content START_OF_ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY =
bpatel@766 88 new Comment("=========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY ===========");
bpatel@766 89
bpatel@766 90 /**
bpatel@766 91 * Marker to identify start of annotation type required member summary.
bpatel@766 92 */
bpatel@766 93 public static final Content START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY =
bpatel@766 94 new Comment("=========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY ===========");
bpatel@766 95
bpatel@766 96 /**
bpatel@766 97 * Marker to identify start of constructor summary.
bpatel@766 98 */
bpatel@766 99 public static final Content START_OF_CONSTRUCTOR_SUMMARY =
bpatel@766 100 new Comment("======== CONSTRUCTOR SUMMARY ========");
bpatel@766 101
bpatel@766 102 /**
bpatel@766 103 * Marker to identify start of enum constants summary.
bpatel@766 104 */
bpatel@766 105 public static final Content START_OF_ENUM_CONSTANT_SUMMARY =
bpatel@766 106 new Comment("=========== ENUM CONSTANT SUMMARY ===========");
bpatel@766 107
bpatel@766 108 /**
bpatel@766 109 * Marker to identify start of field summary.
bpatel@766 110 */
bpatel@766 111 public static final Content START_OF_FIELD_SUMMARY =
bpatel@766 112 new Comment("=========== FIELD SUMMARY ===========");
bpatel@766 113
bpatel@766 114 /**
jjg@1606 115 * Marker to identify start of properties summary.
jjg@1606 116 */
jjg@1606 117 public static final Content START_OF_PROPERTY_SUMMARY =
jjg@1606 118 new Comment("=========== PROPERTY SUMMARY ===========");
jjg@1606 119
jjg@1606 120 /**
bpatel@766 121 * Marker to identify start of method summary.
bpatel@766 122 */
bpatel@766 123 public static final Content START_OF_METHOD_SUMMARY =
bpatel@766 124 new Comment("========== METHOD SUMMARY ===========");
bpatel@766 125
bpatel@766 126 /**
bpatel@766 127 * Marker to identify start of annotation type details.
bpatel@766 128 */
bpatel@766 129 public static final Content START_OF_ANNOTATION_TYPE_DETAILS =
bpatel@766 130 new Comment("============ ANNOTATION TYPE MEMBER DETAIL ===========");
bpatel@766 131
bpatel@766 132 /**
bpatel@766 133 * Marker to identify start of method details.
bpatel@766 134 */
bpatel@766 135 public static final Content START_OF_METHOD_DETAILS =
bpatel@766 136 new Comment("============ METHOD DETAIL ==========");
bpatel@766 137
bpatel@766 138 /**
bpatel@766 139 * Marker to identify start of field details.
bpatel@766 140 */
bpatel@766 141 public static final Content START_OF_FIELD_DETAILS =
bpatel@766 142 new Comment("============ FIELD DETAIL ===========");
bpatel@766 143
bpatel@766 144 /**
jjg@1606 145 * Marker to identify start of property details.
jjg@1606 146 */
jjg@1606 147 public static final Content START_OF_PROPERTY_DETAILS =
jjg@1606 148 new Comment("============ PROPERTY DETAIL ===========");
jjg@1606 149
jjg@1606 150 /**
bpatel@766 151 * Marker to identify start of constructor details.
bpatel@766 152 */
bpatel@766 153 public static final Content START_OF_CONSTRUCTOR_DETAILS =
bpatel@766 154 new Comment("========= CONSTRUCTOR DETAIL ========");
bpatel@766 155
bpatel@766 156 /**
bpatel@766 157 * Marker to identify start of enum constants details.
bpatel@766 158 */
bpatel@766 159 public static final Content START_OF_ENUM_CONSTANT_DETAILS =
bpatel@766 160 new Comment("============ ENUM CONSTANT DETAIL ===========");
bpatel@766 161
bpatel@766 162 /**
bpatel@766 163 * Html tag for the page title heading.
bpatel@766 164 */
bpatel@766 165 public static final HtmlTag TITLE_HEADING = HtmlTag.H1;
bpatel@766 166
bpatel@766 167 /**
bpatel@766 168 * Html tag for the class page title heading.
bpatel@766 169 */
bpatel@766 170 public static final HtmlTag CLASS_PAGE_HEADING = HtmlTag.H2;
bpatel@766 171
bpatel@766 172 /**
bpatel@766 173 * Html tag for the content heading.
bpatel@766 174 */
bpatel@766 175 public static final HtmlTag CONTENT_HEADING = HtmlTag.H2;
bpatel@766 176
bpatel@766 177 /**
bpatel@766 178 * Html tag for the package name heading.
bpatel@766 179 */
bpatel@766 180 public static final HtmlTag PACKAGE_HEADING = HtmlTag.H2;
bpatel@766 181
bpatel@766 182 /**
bpatel@1568 183 * Html tag for the profile name heading.
bpatel@1568 184 */
bpatel@1568 185 public static final HtmlTag PROFILE_HEADING = HtmlTag.H2;
bpatel@1568 186
bpatel@1568 187 /**
bpatel@766 188 * Html tag for the member summary heading.
bpatel@766 189 */
bpatel@766 190 public static final HtmlTag SUMMARY_HEADING = HtmlTag.H3;
bpatel@766 191
bpatel@766 192 /**
bpatel@766 193 * Html tag for the inherited member summary heading.
bpatel@766 194 */
bpatel@766 195 public static final HtmlTag INHERITED_SUMMARY_HEADING = HtmlTag.H3;
bpatel@766 196
bpatel@766 197 /**
bpatel@766 198 * Html tag for the member details heading.
bpatel@766 199 */
bpatel@766 200 public static final HtmlTag DETAILS_HEADING = HtmlTag.H3;
bpatel@766 201
bpatel@766 202 /**
bpatel@766 203 * Html tag for the serialized member heading.
bpatel@766 204 */
bpatel@766 205 public static final HtmlTag SERIALIZED_MEMBER_HEADING = HtmlTag.H3;
bpatel@766 206
bpatel@766 207 /**
bpatel@766 208 * Html tag for the member heading.
bpatel@766 209 */
bpatel@766 210 public static final HtmlTag MEMBER_HEADING = HtmlTag.H4;
bpatel@766 211 }

mercurial