/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/**
* Configure the output based on the options. Doclets should sub-class
* Configuration, to configure and add their own options. This class contains
* all user options which are supported by the 1.1 doclet and the standard
* doclet.
*
* This code is not part of an API.
* It is implementation that is subject to change.
* Do not use it as an API
*
* @author Robert Field.
* @author Atul Dambalkar.
* @author Jamie Ho
*/
public abstract class Configuration {
/**
* The factory for builders.
*/
/**
* The taglet manager.
*/
/**
* The path to the builder XML input file.
*/
/**
* The default path to the builder XML.
*/
/**
* The path to Taglets
*/
/**
* This is true if option "-serialwarn" is used. Defualt value is false to
* supress excessive warnings about serial tag.
*/
public boolean serialwarn = false;
/**
* The specified amount of space between tab stops.
*/
/**
* True if we should generate browsable sources.
*/
public boolean linksource = false;
/**
* True if command line option "-nosince" is used. Default value is
* false.
*/
public boolean nosince = false;
/**
* True if we should recursively copy the doc-file subdirectories
*/
public boolean copydocfilesubdirs = false;
/**
* The META charset tag used for cross-platform viewing.
*/
/**
* True if user wants to add member names as meta keywords.
* Set to false because meta keywords are ignored in general
* by most Internet search engines.
*/
public boolean keywords = false;
/**
* The meta tag keywords instance.
*/
/**
* The list of doc-file subdirectories to exclude
*/
/**
* The list of qualifiers to exclude
*/
/**
* The Root of the generated Program Structure from the Doclet API.
*/
/**
* Destination directory name, in which doclet will generate the entire
* documentation. Default is current directory.
*/
/**
* Destination directory name, in which doclet will copy the doc-files to.
*/
/**
* Encoding for this document. Default is default encoding for this
* platform.
*/
/**
* True if user wants to suppress descriptions and tags.
*/
public boolean nocomment = false;
/**
* Encoding for this document. Default is default encoding for this
* platform.
*/
/**
* Generate author specific information for all the classes if @author
* tag is used in the doc comment and if -author option is used.
* <code>showauthor</code> is set to true if -author option is used.
* Default is don't show author information.
*/
public boolean showauthor = false;
/**
* Generate version specific information for the all the classes
* if @version tag is used in the doc comment and if -version option is
* used. <code>showversion</code> is set to true if -version option is
* used.Default is don't show version information.
*/
public boolean showversion = false;
/**
* Sourcepath from where to read the source files. Default is classpath.
*
*/
/**
* Don't generate deprecated API information at all, if -nodeprecated
* option is used. <code>nodepracted</code> is set to true if
* -nodeprecated option is used. Default is generate deprected API
* information.
*/
public boolean nodeprecated = false;
/**
* The catalog of classes specified on the command-line
*/
/**
* Message Retriever for the doclet, to retrieve message from the resource
* file for this Configuration, which is common for 1.1 and standard
* doclets.
*
* TODO: Make this private!!!
*/
/**
* True if user wants to suppress time stamp in output.
* Default is false.
*/
public boolean notimestamp= false;
/**
* The package grouping instance.
*/
/**
* The tracker of external package links.
*/
/**
* Returns true if the user wants to generate JavaFX documentation.
*/
public static boolean getJavafxJavadoc() {
}
/**
* Location of doclet properties file.
*/
= "com.sun.tools.doclets.internal.toolkit.resources.doclets";
/**
* Return the build date for the doclet.
*/
/**
* This method should be defined in all those doclets(configurations),
* which want to derive themselves from this Configuration. This method
* can be used to set its own command line options.
*
* @param options The array of option names and values.
* @throws DocletAbortException
*/
/**
* Return the doclet specific {@link MessageRetriever}
* @return the doclet specific MessageRetriever.
*/
/**
* An array of the packages specified on the command-line merged
* with the array of packages that contain the classes specified on the
* command-line. The array is sorted.
*/
/**
* Constructor. Constructs the message retriever with resource file.
*/
public Configuration() {
message =
new MessageRetriever(this, DOCLETS_RESOURCE);
}
/**
* Return the builder factory for this doclet.
*
* @return the builder factory for this doclet.
*/
if (builderFactory == null) {
builderFactory = new BuilderFactory(this);
}
return builderFactory;
}
/**
* This method should be defined in all those doclets
* which want to inherit from this Configuration. This method
* should return the number of arguments to the command line
* option (including the option name). For example,
* -notimestamp is a single-argument option, so this method would
* return 1.
*
* @param option Command line option under consideration.
* @return number of arguments to option (including the
* option name). Zero return means option not known.
* Negative value means error occurred.
*/
return 1;
return 2;
return 3;
} else {
return -1; // indicate we don't know about it
}
}
/**
* Perform error checking on the given options.
*
* @param options the given options to check.
* @param reporter the reporter used to report errors.
*/
private void initPackageArray() {
}
}
/**
* Set the command line options supported by this configuration.
*
* @param options the two dimensional array of options.
*/
copydocfilesubdirs = true;
showauthor = true;
nosince = true;
showversion = true;
nodeprecated = true;
linksource = true;
linksource = true;
try {
} catch (NumberFormatException e) {
//Set to -1 so that warning will be printed
//to indicate what is valid argument.
sourcetab = -1;
}
if (sourcetab <= 0) {
}
notimestamp = true;
nocomment = true;
keywords = true;
serialwarn = true;
}
}
}
if (docencoding == null) {
}
}
/**
* Set the command line options supported by this configuration.
*
* @throws DocletAbortException
*/
public void setOptions() {
}
/**
* Initialize the taglet manager. The strings to initialize the simple custom tags should
* be in the following format: "[tag name]:[location str]:[heading]".
* @param customTagStrs the set two dimentional arrays of strings. These arrays contain
* either -tag or -taglet arguments.
*/
continue;
}
//reorder a standard tag
} else {
//Create a simple tag with the heading that has the same name as the tag.
}
//Add simple taglet without heading, probably to excluding it in the output.
} else {
}
}
}
while(st.hasMoreTokens()){
}
}
/**
* Add a traliling file separator, if not found or strip off extra trailing
* file separators if any.
*
* @param path Path under consideration.
* @return String Properly constructed path string.
*/
int indexDblfs;
}
return path;
}
/**
* This checks for the validity of the options used by the user.
* This works exactly like
* {@link com.sun.javadoc.Doclet#validOptions(String[][],
* DocErrorReporter)}. This will validate the options which are shared
* by our doclets. For example, this method will flag an error using
* the DocErrorReporter if user has used "-nohelp" and "-helpfile" option
* together.
*
* @param options options used on the command line.
* @param reporter used to report errors.
* @return true if all the options are valid.
*/
boolean docencodingfound = false;
//Create the output directory (in case it doesn't exist yet)
destdirname));
} else if (!destDir.isDirectory()) {
"doclet.destination_directory_not_directory_0",
return false;
"doclet.destination_directory_not_writable_0",
return false;
}
docencodingfound = true;
return false;
}
}
}
return false;
}
}
return true;
}
/**
* Check the validity of the given Source or Output File encoding on this
* platform.
*
* @param docencoding output file encoding.
* @param reporter used to report errors.
*/
try {
} catch (UnsupportedEncodingException exc) {
docencoding));
return false;
} finally {
try {
}
} catch (IOException exc) {
}
}
return true;
}
/**
* Return true if the given doc-file subdirectory should be excluded and
* false otherwise.
* @param docfilesubdir the doc-files subdirectory to check.
*/
return true;
} else {
return false;
}
}
/**
* Return true if the given qualifier should be excluded and false otherwise.
* @param qualifier the qualifier to check.
*/
return true;
} else {
int index = -1;
return true;
}
}
return false;
}
}
/**
* Return the qualified name of the <code>ClassDoc</code> if it's qualifier is not excluded. Otherwise,
* return the unqualified <code>ClassDoc</code> name.
* @param cd the <code>ClassDoc</code> to check.
*/
} else {
return cd.qualifiedName();
}
}
try {
//Check the doclet specific properties file.
} catch (Exception e) {
//Check the shared properties file.
}
}
try {
//Check the doclet specific properties file.
} catch (Exception e) {
//Check the shared properties file.
}
}
try {
//Check the doclet specific properties file.
} catch (Exception e) {
//Check the shared properties file.
}
}
try {
//Check the doclet specific properties file.
} catch (Exception e) {
//Check the shared properties file.
}
}
/**
* Return true if the ClassDoc element is getting documented, depending upon
* -nodeprecated option and the deprecation information. Return true if
* -nodeprecated is not used. Return false if -nodeprecated is used and if
* either ClassDoc element is deprecated or the containing package is deprecated.
*
* @param cd the ClassDoc for which the page generation is checked
*/
if (!nodeprecated) {
return true;
}
}
/**
* Return the doclet specific instance of a writer factory.
* @return the {@link WriterFactory} for the doclet.
*/
/**
* Return the input stream to the builder XML.
*
* @return the input steam to the builder XML.
* @throws FileNotFoundException when the given XML file cannot be found.
*/
return builderXMLPath == null ?
}
/**
* Return the Locale for this document.
*/
/**
* Return the comparator that will be used to sort member documentation.
* To no do any sorting, return null.
*
* @return the {@link java.util.Comparator} used to sort members.
*/
}