Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocletConstants.java@25e14ad23cef (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocletConstants.java
Wed, 10 Oct 2012 16:48:21 -0700
- author
- jjg
- date
- Wed, 10 Oct 2012 16:48:21 -0700
- changeset 1359
- 25e14ad23cef
- parent 554
- 9d9f26857129
- child 1372
- 78962d89f283
- permissions
- -rw-r--r--
8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy
| duke@1 | 1 | /* |
| jjg@1359 | 2 | * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.util; |
| duke@1 | 27 | |
| duke@1 | 28 | /** |
| duke@1 | 29 | * Stores all constants for a Doclet. Extend this class if you have doclet |
| duke@1 | 30 | * specific constants to add. |
| duke@1 | 31 | * |
| jjg@1359 | 32 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 33 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 34 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 35 | * deletion without notice.</b> |
| duke@1 | 36 | * |
| duke@1 | 37 | * @author Jamie Ho |
| duke@1 | 38 | * @since 1.5 |
| duke@1 | 39 | */ |
| duke@1 | 40 | public class DocletConstants { |
| duke@1 | 41 | |
| duke@1 | 42 | /** |
| duke@1 | 43 | * The default package name. |
| duke@1 | 44 | */ |
| duke@1 | 45 | public static final String DEFAULT_PACKAGE_NAME = "<Unnamed>"; |
| duke@1 | 46 | |
| duke@1 | 47 | /** |
| duke@1 | 48 | * The default package file name. |
| duke@1 | 49 | */ |
| duke@1 | 50 | public static final String DEFAULT_PACKAGE_FILE_NAME = "default"; |
| duke@1 | 51 | |
| duke@1 | 52 | /** |
| duke@1 | 53 | * The anchor for the default package. |
| duke@1 | 54 | */ |
| duke@1 | 55 | public static final String UNNAMED_PACKAGE_ANCHOR = "unnamed_package"; |
| duke@1 | 56 | |
| duke@1 | 57 | /** |
| duke@1 | 58 | * The name of the doc files directory. |
| duke@1 | 59 | */ |
| duke@1 | 60 | public static final String DOC_FILES_DIR_NAME = "doc-files"; |
| duke@1 | 61 | |
| duke@1 | 62 | /** |
| duke@1 | 63 | * The default amount of space between tab stops. |
| duke@1 | 64 | */ |
| duke@1 | 65 | public static final int DEFAULT_TAB_STOP_LENGTH = 8; |
| duke@1 | 66 | |
| duke@1 | 67 | /** |
| duke@1 | 68 | * The name of the directory where we will copy resource files to. |
| duke@1 | 69 | */ |
| duke@1 | 70 | public static final String RESOURE_DIR_NAME = "resources"; |
| duke@1 | 71 | |
| duke@1 | 72 | /** |
| duke@1 | 73 | * The source output directory name |
| duke@1 | 74 | */ |
| duke@1 | 75 | public static final String SOURCE_OUTPUT_DIR_NAME = "src-html/"; |
| duke@1 | 76 | |
| duke@1 | 77 | /** |
| duke@1 | 78 | * The name of the package list file. |
| duke@1 | 79 | */ |
| duke@1 | 80 | public static final String PACKAGE_LIST_FILE_NAME = "package-list"; |
| duke@1 | 81 | |
| duke@1 | 82 | /** |
| duke@1 | 83 | * The line seperator for the current operating system. |
| duke@1 | 84 | */ |
| duke@1 | 85 | public static final String NL = System.getProperty("line.separator"); |
| duke@1 | 86 | } |
