1 |
/* gnu.classpath.tools.gjdoc.Main |
/* gnu.classpath.tools.gjdoc.Main |
2 |
Copyright (C) 2001 Free Software Foundation, Inc. |
Copyright (C) 2001 Free Software Foundation, Inc. |
3 |
|
|
4 |
This file is part of GNU Classpath. |
This file is part of GNU Classpath. |
5 |
|
|
6 |
GNU Classpath is free software; you can redistribute it and/or modify |
GNU Classpath is free software; you can redistribute it and/or modify |
7 |
it under the terms of the GNU General Public License as published by |
it under the terms of the GNU General Public License as published by |
8 |
the Free Software Foundation; either version 2, or (at your option) |
the Free Software Foundation; either version 2, or (at your option) |
9 |
any later version. |
any later version. |
10 |
|
|
11 |
GNU Classpath is distributed in the hope that it will be useful, but |
GNU Classpath is distributed in the hope that it will be useful, but |
12 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
WITHOUT ANY WARRANTY; without even the implied warranty of |
13 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
14 |
General Public License for more details. |
General Public License for more details. |
15 |
|
|
16 |
You should have received a copy of the GNU General Public License |
You should have received a copy of the GNU General Public License |
17 |
along with GNU Classpath; see the file COPYING. If not, write to the |
along with GNU Classpath; see the file COPYING. If not, write to the |
18 |
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
19 |
02111-1307 USA. */ |
02111-1307 USA. */ |
20 |
|
|
21 |
package gnu.classpath.tools.gjdoc; |
package gnu.classpath.tools.gjdoc; |
22 |
|
|
167 |
/** |
/** |
168 |
* Option "-locale:" Specify the locale charset of Java source files. |
* Option "-locale:" Specify the locale charset of Java source files. |
169 |
*/ |
*/ |
170 |
private Locale option_locale = Locale.getDefault(); |
private Locale option_locale = new Locale("en", "us"); |
171 |
|
|
172 |
/** |
/** |
173 |
* Option "-encoding": Specify character encoding of Java source files. |
* Option "-encoding": Specify character encoding of Java source files. |
379 |
options.add(optionAndValues); |
options.add(optionAndValues); |
380 |
} |
} |
381 |
} |
} |
382 |
else |
else if (option.length() > 0) |
383 |
{ |
{ |
384 |
|
|
385 |
//--- Add to list of packages/classes if not option or option |
//--- Add to list of packages/classes if not option or option |
860 |
|
|
861 |
//--- We have all information we need to start the doclet at this time |
//--- We have all information we need to start the doclet at this time |
862 |
|
|
863 |
rootDoc.setSourceEncoding(option_encoding); |
if (null != option_encoding) { |
864 |
|
rootDoc.setSourceEncoding(option_encoding); |
865 |
|
} |
866 |
|
else { |
867 |
|
rootDoc.setSourceEncoding("US-ASCII"); // FIXME |
868 |
|
} |
869 |
rootDoc.setSourcePath(option_sourcepath); |
rootDoc.setSourcePath(option_sourcepath); |
870 |
|
|
871 |
//addJavaLangClasses(); |
//addJavaLangClasses(); |
1226 |
System.err |
System.err |
1227 |
.print("\n" |
.print("\n" |
1228 |
+ "USAGE: gjdoc [options] [packagenames] " |
+ "USAGE: gjdoc [options] [packagenames] " |
1229 |
+ /* "[sourcefiles] "+ */"[classnames] [@files]\n\n" |
+ "[sourcefiles] [classnames] [@files]\n\n" |
1230 |
+ " -overview <file> Read overview documentation from HTML file\n" |
+ " -overview <file> Read overview documentation from HTML file\n" |
1231 |
+ " -public Include only public classes and members\n" |
+ " -public Include only public classes and members\n" |
1232 |
+ " -protected Include protected and public classes and members.\n" |
+ " -protected Include protected and public classes and members.\n" |
1233 |
+ " This is the default.\n" |
+ " This is the default.\n" |
1234 |
+ " -package Include package/protected/public classes and members\n" |
+ " -package Include package/protected/public classes and members\n" |
1235 |
+ " -private Include all classes and members\n" |
+ " -private Include all classes and members\n" |
1236 |
+ " -help Show this information\n" |
+ " -help Show this information\n" |
1237 |
+ " -doclet <class> Doclet class to use for generating output\n" |
+ " -doclet <class> Doclet class to use for generating output\n" |
1238 |
+ " -docletpath <classpath> Specifies the search path for the doclet and dependencies\n" |
+ " -docletpath <classpath> Specifies the search path for the doclet and dependencies\n" |
1239 |
+ " -source <release> Provide source compatibility with specified release (1.4 to handle assertion)\n" |
+ " -source <release> Provide source compatibility with specified release (1.4 to handle assertion)\n" |
1240 |
+ " -sourcepath <pathlist> Where to look for source files\n" |
+ " -sourcepath <pathlist> Where to look for source files\n" |
1241 |
+ " -verbose Output messages about what Gjdoc is doing [ignored]\n" |
+ " -verbose Output messages about what Gjdoc is doing [ignored]\n" |
1242 |
+ " -quiet Do not print non-error and non-warning messages\n" |
+ " -quiet Do not print non-error and non-warning messages\n" |
1243 |
+ " -locale <name> Locale to be used, e.g. en_US or en_US_WIN [ignored]\n" |
+ " -locale <name> Locale to be used, e.g. en_US or en_US_WIN [ignored]\n" |
1244 |
+ " -encoding <name> Source file encoding name\n" |
+ " -encoding <name> Source file encoding name\n" |
1245 |
+ " -breakiterator Compute first sentence with BreakIterator\n" |
+ " -breakiterator Compute first sentence with BreakIterator\n" |
1246 |
|
|
1247 |
+ "Standard doclet options:\n" |
+ "Standard doclet options:\n" |
1248 |
+ " -d Set target directory\n" |
+ " -d Set target directory\n" |
1249 |
/* + " -use Includes the 'Use' page for each documented class and package\n" */ |
+ " -use Includes the 'Use' page for each documented class and package\n" |
1250 |
+ " -version Includes the '@version' tag\n" |
+ " -version Includes the '@version' tag\n" |
1251 |
+ " -author Includes the '@author' tag\n" |
+ " -author Includes the '@author' tag\n" |
1252 |
+ " -splitindex Splits the index file into multiple files\n" |
+ " -splitindex Splits the index file into multiple files\n" |
1253 |
+ " -windowtitle <text> Browser window title\n" |
+ " -windowtitle <text> Browser window title\n" |
1254 |
+ " -doctitle <text> Title near the top of the overview summary file (html allowed)\n" |
+ " -doctitle <text> Title near the top of the overview summary file (html allowed)\n" |
1255 |
+ " -title <text> Title for this set of API documentation (deprecated, -doctitle should be used instead).\n" |
+ " -title <text> Title for this set of API documentation (deprecated, -doctitle should be used instead).\n" |
1256 |
+ " -header <text> Text to include in the top navigation bar (html allowed)\n" |
+ " -header <text> Text to include in the top navigation bar (html allowed)\n" |
1257 |
+ " -footer <text> Text to include in the bottom navigation bar (html allowed)\n" |
+ " -footer <text> Text to include in the bottom navigation bar (html allowed)\n" |
1258 |
+ " -bottom <text> Text to include at the bottom of each output file (html allowed)\n" |
+ " -bottom <text> Text to include at the bottom of each output file (html allowed)\n" |
1259 |
/* + " -link <extdoc URL> Link to external javadoc-generated documentation you want to link to\n" */ |
+ " -link <extdoc URL> Link to external javadoc-generated documentation you want to link to\n" |
1260 |
/* + " -linkoffline <extdoc URL> <packagelistLoc> Link to external javadoc-generated documentation for the specified package-list\n" */ |
+ " -linkoffline <extdoc URL> <packagelistLoc> Link to external javadoc-generated documentation for the specified package-list\n" |
1261 |
+ " -linksource Creates an HTML version of each source file\n" |
+ " -linksource Creates an HTML version of each source file\n" |
1262 |
+ " -group <groupheading> <packagepattern:packagepattern:...> Separates packages on the overview page into groups\n" |
+ " -group <groupheading> <packagepattern:packagepattern:...> Separates packages on the overview page into groups\n" |
1263 |
+ " -nodeprecated Prevents the generation of any deprecated API\n" |
+ " -nodeprecated Prevents the generation of any deprecated API\n" |
1264 |
+ " -nodeprecatedlist Prevents the generation of the file containing the list of deprecated APIs and the link to the navigation bar to that page\n" |
+ " -nodeprecatedlist Prevents the generation of the file containing the list of deprecated APIs and the link to the navigation bar to that page\n" |
1265 |
+ " -nosince Omit the '@since' tag\n" |
+ " -nosince Omit the '@since' tag\n" |
1266 |
+ " -notree Do not generate the class/interface hierarchy page\n" |
+ " -notree Do not generate the class/interface hierarchy page\n" |
1267 |
+ " -noindex Do not generate the index file\n" |
+ " -noindex Do not generate the index file\n" |
1268 |
+ " -nohelp Do not generate the HELP link\n" |
+ " -nohelp Do not generate the HELP link\n" |
1269 |
+ " -nonavbar Do not generate the navbar, header and footer\n" |
+ " -nonavbar Do not generate the navbar, header and footer\n" |
1270 |
+ " -helpfile <filename> Path of an alternate help file\n" |
+ " -helpfile <filename> Path of an alternate help file\n" |
1271 |
+ " -stylesheetfile <filename> Path of an alternate html stylesheet\n" |
+ " -stylesheetfile <filename> Path of an alternate html stylesheet\n" |
1272 |
/* + " -serialwarn Generate compile time error for missing '@serial' tags\n" */ |
/* + " -serialwarn Generate compile time error for missing '@serial' tags\n" */ |
1273 |
/* + " -charset <IANACharset> Specifies the HTML charset\n" */ |
+ " -charset <IANACharset> Specifies the HTML charset\n" |
1274 |
/* + " -docencoding <IANACharset> Specifies the encoding of the generated HTML files\n" */ |
+ " -docencoding <IANACharset> Specifies the encoding of the generated HTML files\n" |
1275 |
+ " -tag <tagname>:Xaoptcmf:\"<taghead>\" Enables gjdoc to interpret a custom tag\n" |
+ " -tag <tagname>:Xaoptcmf:\"<taghead>\" Enables gjdoc to interpret a custom tag\n" |
1276 |
+ " -taglet Adds a Taglet class to the map of taglets.\n" |
+ " -taglet Adds a Taglet class to the map of taglets.\n" |
1277 |
+ " -tagletpath Sets the CLASSPATH to load subsequent Taglets from.\n" |
+ " -tagletpath Sets the CLASSPATH to load subsequent Taglets from.\n" |
1278 |
+ " -subpackages <spkglist> List of subpackages to recursively load\n" |
+ " -subpackages <spkglist> List of subpackages to recursively load\n" |
1279 |
+ " -exclude <pkglist> List of packages to exclude\n" |
+ " -exclude <pkglist> List of packages to exclude\n" |
1280 |
+ " -docfilessubdirs Enables deep copy of 'doc-files' directories\n" |
+ " -docfilessubdirs Enables deep copy of 'doc-files' directories\n" |
1281 |
+ " -excludedocfilessubdir <name1:name2:...> Excludes 'doc-files' subdirectories with a give name\n" |
+ " -excludedocfilessubdir <name1:name2:...> Excludes 'doc-files' subdirectories with a give name\n" |
1282 |
/* + " -noqualifier all|<packagename1:packagename2:...> Do not qualify package name from ahead of class names\n" */ |
/* + " -noqualifier all|<packagename1:packagename2:...> Do not qualify package name from ahead of class names\n" */ |
1283 |
/* + " -nocomment Suppress the entire comment body including the main description and all tags, only generate the declarations\n" */ |
/* + " -nocomment Suppress the entire comment body including the main description and all tags, only generate the declarations\n" */ |
1284 |
|
/** |
1285 |
+ " -genhtml Generate HTML code instead of XML code. This is the\n" |
+ " -genhtml Generate HTML code instead of XML code. This is the\n" |
1286 |
+ " default.\n" |
+ " default.\n" |
1287 |
+ " -geninfo Generate Info code instead of XML code.\n" |
+ " -geninfo Generate Info code instead of XML code.\n" |
1311 |
+ " mailto-name replace by <a>Real Name</a>.\n" |
+ " mailto-name replace by <a>Real Name</a>.\n" |
1312 |
+ " name-mailto-address replace by Real Name (<a>abc@foo.com</a>).\n" |
+ " name-mailto-address replace by Real Name (<a>abc@foo.com</a>).\n" |
1313 |
+ " name-mangled-address replace by Real Name (<a>abc AT foo DOT com</a>).\n" |
+ " name-mangled-address replace by Real Name (<a>abc AT foo DOT com</a>).\n" |
1314 |
|
**/ |
1315 |
); |
); |
1316 |
} |
} |
1317 |
|
|
1399 |
*/ |
*/ |
1400 |
public boolean isUseBreakIterator() |
public boolean isUseBreakIterator() |
1401 |
{ |
{ |
1402 |
return this.option_breakiterator; |
return this.option_breakiterator |
1403 |
|
|| !getLocale().getLanguage().equals(Locale.ENGLISH.getLanguage()); |
1404 |
} |
} |
1405 |
|
|
1406 |
/** |
/** |