Tue, 03 Dec 2013 14:21:45 -0800
8025416: doclet not substituting {@docRoot} in some cases
Reviewed-by: jjg
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.tools.doclets.formats.html; |
aoqi@0 | 27 | |
aoqi@0 | 28 | /** |
aoqi@0 | 29 | * Enum representing various section names of generated API documentation. |
aoqi@0 | 30 | * |
aoqi@0 | 31 | * <p><b>This is NOT part of any supported API. |
aoqi@0 | 32 | * If you write code that depends on this, you do so at your own risk. |
aoqi@0 | 33 | * This code and its internal interfaces are subject to change or |
aoqi@0 | 34 | * deletion without notice.</b> |
aoqi@0 | 35 | * |
aoqi@0 | 36 | * @author Bhavesh Patel |
aoqi@0 | 37 | */ |
aoqi@0 | 38 | public enum SectionName { |
aoqi@0 | 39 | |
aoqi@0 | 40 | ANNOTATION_TYPE_ELEMENT_DETAIL("annotation.type.element.detail"), |
aoqi@0 | 41 | ANNOTATION_TYPE_FIELD_DETAIL("annotation.type.field.detail"), |
aoqi@0 | 42 | ANNOTATION_TYPE_FIELD_SUMMARY("annotation.type.field.summary"), |
aoqi@0 | 43 | ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY("annotation.type.optional.element.summary"), |
aoqi@0 | 44 | ANNOTATION_TYPE_REQUIRED_ELEMENT_SUMMARY("annotation.type.required.element.summary"), |
aoqi@0 | 45 | CONSTRUCTOR_DETAIL("constructor.detail"), |
aoqi@0 | 46 | CONSTRUCTOR_SUMMARY("constructor.summary"), |
aoqi@0 | 47 | ENUM_CONSTANT_DETAIL("enum.constant.detail"), |
aoqi@0 | 48 | ENUM_CONSTANTS_INHERITANCE("enum.constants.inherited.from.class."), |
aoqi@0 | 49 | ENUM_CONSTANT_SUMMARY("enum.constant.summary"), |
aoqi@0 | 50 | FIELD_DETAIL("field.detail"), |
aoqi@0 | 51 | FIELDS_INHERITANCE("fields.inherited.from.class."), |
aoqi@0 | 52 | FIELD_SUMMARY("field.summary"), |
aoqi@0 | 53 | METHOD_DETAIL("method.detail"), |
aoqi@0 | 54 | METHODS_INHERITANCE("methods.inherited.from.class."), |
aoqi@0 | 55 | METHOD_SUMMARY("method.summary"), |
aoqi@0 | 56 | NAVBAR_BOTTOM("navbar.bottom"), |
aoqi@0 | 57 | NAVBAR_BOTTOM_FIRSTROW("navbar.bottom.firstrow"), |
aoqi@0 | 58 | NAVBAR_TOP("navbar.top"), |
aoqi@0 | 59 | NAVBAR_TOP_FIRSTROW("navbar.top.firstrow"), |
aoqi@0 | 60 | NESTED_CLASSES_INHERITANCE("nested.classes.inherited.from.class."), |
aoqi@0 | 61 | NESTED_CLASS_SUMMARY("nested.class.summary"), |
aoqi@0 | 62 | OVERVIEW_DESCRIPTION("overview.description"), |
aoqi@0 | 63 | PACKAGE_DESCRIPTION("package.description"), |
aoqi@0 | 64 | PROPERTY_DETAIL("property.detail"), |
aoqi@0 | 65 | PROPERTIES_INHERITANCE("properties.inherited.from.class."), |
aoqi@0 | 66 | PROPERTY_SUMMARY("property.summary"), |
aoqi@0 | 67 | SKIP_NAVBAR_BOTTOM("skip.navbar.bottom"), |
aoqi@0 | 68 | SKIP_NAVBAR_TOP("skip.navbar.top"), |
aoqi@0 | 69 | UNNAMED_PACKAGE_ANCHOR("unnamed.package"); |
aoqi@0 | 70 | |
aoqi@0 | 71 | private final String value; |
aoqi@0 | 72 | |
aoqi@0 | 73 | SectionName(String sName) { |
aoqi@0 | 74 | this.value = sName; |
aoqi@0 | 75 | } |
aoqi@0 | 76 | |
aoqi@0 | 77 | public String getName() { |
aoqi@0 | 78 | return this.value; |
aoqi@0 | 79 | } |
aoqi@0 | 80 | } |