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

Mon, 15 Oct 2012 17:07:55 -0700

author
jjg
date
Mon, 15 Oct 2012 17:07:55 -0700
changeset 1364
8db45b13526e
parent 1359
25e14ad23cef
child 1372
78962d89f283
permissions
-rw-r--r--

8000666: javadoc should write directly to Writer instead of composing strings
Reviewed-by: bpatel

     1 /*
     2  * Copyright (c) 2003, 2012, 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  *  <p><b>This is NOT part of any supported API.
    33  *  If you write code that depends on this, you do so at your own risk.
    34  *  This code and its internal interfaces are subject to change or
    35  *  deletion without notice.</b>
    36  *
    37  * @author Jamie Ho
    38  * @since 1.5
    39  */
    40 public class DocletConstants {
    42     /**
    43      * The default package name.
    44      */
    45     public static final String DEFAULT_PACKAGE_NAME = "&lt;Unnamed&gt;";
    47     /**
    48      * The default package file name.
    49      */
    50     public static final String DEFAULT_PACKAGE_FILE_NAME = "default";
    52     /**
    53      * The anchor for the default package.
    54      */
    55     public static final String UNNAMED_PACKAGE_ANCHOR = "unnamed_package";
    57     /**
    58      * The name of the doc files directory.
    59      */
    60     public static final String DOC_FILES_DIR_NAME = "doc-files";
    62     /**
    63      * The default amount of space between tab stops.
    64      */
    65     public static final int DEFAULT_TAB_STOP_LENGTH = 8;
    67     /**
    68      * The name of the directory where we will copy resource files to.
    69      */
    70     public static final String RESOURE_DIR_NAME = "resources";
    72     /**
    73      * The source output directory name
    74      */
    75     public static final String SOURCE_OUTPUT_DIR_NAME = "src-html/";
    77     /**
    78      * The name of the package list file.
    79      */
    80     public static final String PACKAGE_LIST_FILE_NAME = "package-list";
    82     /**
    83      * The line seperator for the current operating system.
    84      */
    85     public static final String NL = System.getProperty("line.separator");
    86 }

mercurial