1 /* 2 * Copyright (c) 2010, 2019, 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 */ 25 26 package jdk.javadoc.internal.doclets.formats.html; 27 28 import jdk.javadoc.internal.doclets.formats.html.markup.Comment; 29 30 /** 31 * Marker comments to identify regions in the generated files. 32 * 33 * <p><b>This is NOT part of any supported API. 34 * If you write code that depends on this, you do so at your own risk. 35 * This code and its internal interfaces are subject to change or 36 * deletion without notice.</b> 37 */ 38 public class MarkerComments { 39 40 /** 41 * Marker to identify start of top navigation bar. 42 */ 43 public static final Comment START_OF_TOP_NAVBAR = 44 new Comment("========= START OF TOP NAVBAR ======="); 45 46 /** 47 * Marker to identify end of top navigation bar. 48 */ 49 public static final Comment END_OF_TOP_NAVBAR = 50 new Comment("========= END OF TOP NAVBAR ========="); 51 52 /** 53 * Marker to identify start of module description. 54 */ 55 public static final Comment START_OF_MODULE_DESCRIPTION = 56 new Comment("============ MODULE DESCRIPTION ==========="); 57 58 /** 59 * Marker to identify start of modules summary. 60 */ 61 public static final Comment START_OF_MODULES_SUMMARY = 62 new Comment("============ MODULES SUMMARY ==========="); 63 64 /** 65 * Marker to identify start of packages summary. 66 */ 67 public static final Comment START_OF_PACKAGES_SUMMARY = 68 new Comment("============ PACKAGES SUMMARY ==========="); 69 70 /** 71 * Marker to identify start of services summary. 72 */ 73 public static final Comment START_OF_SERVICES_SUMMARY = 74 new Comment("============ SERVICES SUMMARY ==========="); 75 76 /** 77 * Marker to identify start of class data. 78 */ 79 public static final Comment START_OF_CLASS_DATA = 80 new Comment("======== START OF CLASS DATA ========"); 81 82 /** 83 * Marker to identify end of class data. 84 */ 85 public static final Comment END_OF_CLASS_DATA = 86 new Comment("========= END OF CLASS DATA ========="); 87 88 /** 89 * Marker to identify start of nested class summary. 90 */ 91 public static final Comment START_OF_NESTED_CLASS_SUMMARY = 92 new Comment("======== NESTED CLASS SUMMARY ========"); 93 94 /** 95 * Marker to identify start of annotation type optional member summary. 96 */ 97 public static final Comment START_OF_ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY = 98 new Comment("=========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY ==========="); 99 100 /** 101 * Marker to identify start of annotation interface optional member summary. 102 */ 103 public static final Comment START_OF_ANNOTATION_INTERFACE_OPTIONAL_MEMBER_SUMMARY = 104 new Comment("=========== ANNOTATION INTERFACE OPTIONAL MEMBER SUMMARY ==========="); 105 106 /** 107 * Marker to identify start of annotation type required member summary. 108 */ 109 public static final Comment START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY = 110 new Comment("=========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY ==========="); 111 112 /** 113 * Marker to identify start of annotation interface required member summary. 114 */ 115 public static final Comment START_OF_ANNOTATION_INTERFACE_REQUIRED_MEMBER_SUMMARY = 116 new Comment("=========== ANNOTATION INTERFACE REQUIRED MEMBER SUMMARY ==========="); 117 118 /** 119 * Marker to identify start of constructor summary. 120 */ 121 public static final Comment START_OF_CONSTRUCTOR_SUMMARY = 122 new Comment("======== CONSTRUCTOR SUMMARY ========"); 123 124 /** 125 * Marker to identify start of enum constants summary. 126 */ 127 public static final Comment START_OF_ENUM_CONSTANT_SUMMARY = 128 new Comment("=========== ENUM CONSTANT SUMMARY ==========="); 129 130 /** 131 * Marker to identify start of field summary. 132 */ 133 public static final Comment START_OF_FIELD_SUMMARY = 134 new Comment("=========== FIELD SUMMARY ==========="); 135 136 /** 137 * Marker to identify start of properties summary. 138 */ 139 public static final Comment START_OF_PROPERTY_SUMMARY = 140 new Comment("=========== PROPERTY SUMMARY ==========="); 141 142 /** 143 * Marker to identify start of method summary. 144 */ 145 public static final Comment START_OF_METHOD_SUMMARY = 146 new Comment("========== METHOD SUMMARY ==========="); 147 148 /** 149 * Marker to identify start of annotation type details. 150 */ 151 public static final Comment START_OF_ANNOTATION_TYPE_DETAILS = 152 new Comment("============ ANNOTATION TYPE MEMBER DETAIL ==========="); 153 154 /** 155 * Marker to identify start of annotation interface details. 156 */ 157 public static final Comment START_OF_ANNOTATION_INTERFACE_DETAILS = 158 new Comment("============ ANNOTATION INTERFACE MEMBER DETAIL ==========="); 159 160 /** 161 * Marker to identify start of method details. 162 */ 163 public static final Comment START_OF_METHOD_DETAILS = 164 new Comment("============ METHOD DETAIL =========="); 165 166 /** 167 * Marker to identify start of field details. 168 */ 169 public static final Comment START_OF_FIELD_DETAILS = 170 new Comment("============ FIELD DETAIL ==========="); 171 172 /** 173 * Marker to identify start of property details. 174 */ 175 public static final Comment START_OF_PROPERTY_DETAILS = 176 new Comment("============ PROPERTY DETAIL ==========="); 177 178 /** 179 * Marker to identify start of constructor details. 180 */ 181 public static final Comment START_OF_CONSTRUCTOR_DETAILS = 182 new Comment("========= CONSTRUCTOR DETAIL ========"); 183 184 /** 185 * Marker to identify start of enum constants details. 186 */ 187 public static final Comment START_OF_ENUM_CONSTANT_DETAILS = 188 new Comment("============ ENUM CONSTANT DETAIL ==========="); 189 190 } 191