src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocletConstants.java

Mon, 02 May 2011 02:13:02 -0700

author
bpatel
date
Mon, 02 May 2011 02:13:02 -0700
changeset 995
62bc3775d5bb
parent 554
9d9f26857129
child 1359
25e14ad23cef
permissions
-rw-r--r--

6492694: @deprecated tag doesn't work in package-info files.
Reviewed-by: jjg

     1 /*
     2  * Copyright (c) 2003, 2004, 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  */
    26 package com.sun.tools.doclets.internal.toolkit.util;
    28 /**
    29  * Stores all constants for a Doclet.  Extend this class if you have doclet
    30  * specific constants to add.
    31  *
    32  * This code is not part of an API.
    33  * It is implementation that is subject to change.
    34  * Do not use it as an API
    35  *
    36  * @author Jamie Ho
    37  * @since 1.5
    38  */
    39 public class DocletConstants {
    41     /**
    42      * The default package name.
    43      */
    44     public static final String DEFAULT_PACKAGE_NAME = "<Unnamed>";
    46     /**
    47      * The default package file name.
    48      */
    49     public static final String DEFAULT_PACKAGE_FILE_NAME = "default";
    51     /**
    52      * The anchor for the default package.
    53      */
    54     public static final String UNNAMED_PACKAGE_ANCHOR = "unnamed_package";
    56     /**
    57      * The name of the doc files directory.
    58      */
    59     public static final String DOC_FILES_DIR_NAME = "doc-files";
    61     /**
    62      * The default amount of space between tab stops.
    63      */
    64     public static final int DEFAULT_TAB_STOP_LENGTH = 8;
    66     /**
    67      * The name of the directory where we will copy resource files to.
    68      */
    69     public static final String RESOURE_DIR_NAME = "resources";
    71     /**
    72      * The source output directory name
    73      */
    74     public static final String SOURCE_OUTPUT_DIR_NAME = "src-html/";
    76     /**
    77      * The name of the package list file.
    78      */
    79     public static final String PACKAGE_LIST_FILE_NAME = "package-list";
    81     /**
    82      * The line seperator for the current operating system.
    83      */
    84     public static final String NL = System.getProperty("line.separator");
    85 }

mercurial