01: /*
02: * Copyright 2003-2004 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.tools.doclets.internal.toolkit.util;
27:
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 {
40:
41: /**
42: * The default package name.
43: */
44: public static final String DEFAULT_PACKAGE_NAME = "<Unnamed>";
45:
46: /**
47: * The default package file name.
48: */
49: public static final String DEFAULT_PACKAGE_FILE_NAME = "default";
50:
51: /**
52: * The anchor for the default package.
53: */
54: public static final String UNNAMED_PACKAGE_ANCHOR = "unnamed_package";
55:
56: /**
57: * The name of the doc files directory.
58: */
59: public static final String DOC_FILES_DIR_NAME = "doc-files";
60:
61: /**
62: * The default amount of space between tab stops.
63: */
64: public static final int DEFAULT_TAB_STOP_LENGTH = 8;
65:
66: /**
67: * The name of the directory where we will copy resource files to.
68: */
69: public static final String RESOURE_DIR_NAME = "resources";
70:
71: /**
72: * The source output directory name
73: */
74: public static final String SOURCE_OUTPUT_DIR_NAME = "src-html/";
75:
76: /**
77: * The name of the package list file.
78: */
79: public static final String PACKAGE_LIST_FILE_NAME = "package-list";
80:
81: /**
82: * The line seperator for the current operating system.
83: */
84: public static final String NL = System
85: .getProperty("line.separator");
86: }
|