gjdoc-6 --version (return code: 0)
gjdoc 0.99
gjdoc-6 --help (return code: 0)
USAGE: gjdoc [options] [packagenames] [sourcefiles] [@files]
--version Show version information and exit
-all Process all source files found in the source path
-overview <file> Read overview documentation from HTML file
-public Include only public classes and members
-protected Include protected and public classes and members
This is the default
-package Include package/protected/public classes and members
-private Include all classes and members
-help, --help Show this information
-doclet <class> Doclet class to use for generating output
-docletpath <classpath> Specifies the search path for the doclet and
dependencies
-source <release> Provide source compatibility with specified
release (1.4 to handle assertion)
-sourcepath <pathlist> Where to look for source files
-s <pathlist> Alias for -sourcepath
-subpackages <spkglist> List of subpackages to recursively load
-exclude <pkglist> List of packages to exclude
-verbose Output messages about what Gjdoc is doing [ignored]
-quiet Do not print non-error and non-warning messages
-locale <name> Locale to be used, e.g. en_US or en_US_WIN
-encoding <name> Source file encoding name
-breakiterator Compute first sentence with BreakIterator
-classpath <pathlist> Set the path used for loading auxilliary classes
Standard doclet options:
-d Set target directory
-use Includes the 'Use' page for each documented class
and package
-version Includes the '@version' tag
-author Includes the '@author' tag
-splitindex Splits the index file into multiple files
-windowtitle <text> Browser window title
-doctitle <text> Title near the top of the overview summary file
(HTML allowed)
-title <text> Title for this set of API documentation
(deprecated, -doctitle should be used instead)
-header <text> Text to include in the top navigation bar
(HTML allowed)
-footer <text> Text to include in the bottom navigation bar
(HTML allowed)
-bottom <text> Text to include at the bottom of each output file
(HTML allowed)
-link <extdoc URL> Link to external generated documentation at URL
-linkoffline <extdoc URL> <packagelistLoc>
Link to external generated documentation for
the specified package-list
-linksource Creates an HTML version of each source file
-group <groupheading> <packagepattern:packagepattern:...>
Separates packages on the overview page into groups
-nodeprecated Prevents the generation of any deprecated API
-nodeprecatedlist Prevents the generation of the file containing
the list of deprecated APIs and the link to the
navigation bar to that page
-nosince Omit the '@since' tag
-notree Do not generate the class/interface hierarchy page
-noindex Do not generate the index file
-nohelp Do not generate the help link
-nonavbar Do not generate the navbar, header and footer
-helpfile <filen> Path to an alternate help file
-stylesheetfile <file> Path to an alternate CSS stylesheet
-addstylesheet <file> Path to an additional CSS stylesheet
-serialwarn Complain about missing '@serial' tags [ignored]
-charset <IANACharset> Specifies the HTML charset
-docencoding <IANACharset>
Specifies the encoding of the generated HTML files
-tag <tagname>:Xaoptcmf:"<taghead>"
Enables gjdoc to interpret a custom tag
-taglet Adds a Taglet class to the map of taglets
-tagletpath Sets the CLASSPATH to load subsequent Taglets from
-docfilessubdirs Enables deep copy of 'doc-files' directories
-excludedocfilessubdir <name1:name2:...>
Excludes 'doc-files' subdirectories with a give name
-noqualifier all|<packagename1:packagename2:...>
Do never fully qualify given package names
-nocomment Suppress the entire comment body including the main
description and all tags, only generate declarations
Gjdoc extension options:
-reflection Use reflection for resolving unqualified class names
-licensetext Include license text from source files
-validhtml Use valid HTML/XML names (breaks compatibility)
-baseurl <url> Hardwire the given base URL into generated pages