OS Manuals

/usr/lib/jvm/java-11-zulu/bin/javadoc

Zulu 11 Java development kit (CPU stream)

From zulu-11-cpu 11.0.31.0.101-r2 (enterprise-packages), captured 2026-11-08 by running javadoc --help (exit 0). permalink

Also provided by 1 other package version
Usage:
    javadoc [options] [packagenames] [sourcefiles] [@files]
where options include:
    --add-modules <module>(,<module>)*
                  Root modules to resolve in addition to the initial modules,
                  or all modules on the module path if <module> is
                  ALL-MODULE-PATH.
    -bootclasspath <path>
                  Override location of platform class files used for non-modular
                  releases
    -breakiterator
                  Compute first sentence with BreakIterator
    --class-path <path>, -classpath <path>, -cp <path>
                  Specify where to find user class files
    -doclet <class>
                  Generate output via alternate doclet
    -docletpath <path>
                  Specify where to find doclet class files
    --enable-preview
                  Enable preview language features. To be used in conjunction with
                  either -source or --release.
    -encoding <name>
                  Source file encoding name
    -exclude <pkglist>
                  Specify a list of packages to exclude
    --expand-requires <value>
                  Instructs the tool to expand the set of modules to be
                  documented. By default, only the modules given explicitly on
                  the command line will be documented. A value of "transitive"
                  will additionally include all "requires transitive"
                  dependencies of those modules. A value of "all" will include
                  all dependencies of those modules.
    -extdirs <dirlist>
                  Override location of installed extensions
    --help, -help, -?, -h
                  Display command line options and exit
    --help-extra, -X
                  Print a synopsis of nonstandard options and exit
    -J<flag>      Pass <flag> directly to the runtime system
    --limit-modules <module>(,<module>)*
                  Limit the universe of observable modules
    -locale <name>
                  Locale to be used, e.g. en_US or en_US_WIN
    --module <module>(,<module>)*
                  Document the specified module(s)
    --module-path <path>, -p <path>
                  Specify where to find application modules
    --module-source-path <path>
                  Specify where to find input source files for multiple modules
    -package
                  Show package/protected/public types and members. For
                  named modules, show all packages and all module details.
    -private
                  Show all types and members. For named modules,
                  show all packages and all module details.
    -protected
                  Show protected/public types and members (default). For
                  named modules, show exported packages and the module's API.
    -public
                  Show only public types and members. For named modules,
                  show exported packages and the module's API.
    -quiet        Do not display status messages
    --release <release>
                  Provide source compatibility with specified release
    --show-members <value>
                  Specifies which members (fields, methods, etc.) will be
                  documented, where value can be one of "public", "protected",
                  "package" or "private". The default is "protected", which will
                  show public and protected members, "public" will show only
                  public members, "package" will show public, protected and
                  package members and "private" will show all members.
    --show-module-contents <value>
                  Specifies the documentation granularity of module
                  declarations. Possible values are "api" or "all".
    --show-packages <value>
                  Specifies which modules packages will be documented. Possible
                  values are "exported" or "all" packages.
    --show-types <value>
                  Specifies which types (classes, interfaces, etc.) will be
                  documented, where value can be one of "public", "protected",
                  "package" or "private". The default is "protected", which will
                  show public and protected types, "public" will show only
                  public types, "package" will show public, protected and
                  package types and "private" will show all types.
    -source <release>
                  Provide source compatibility with specified release
    --source-path <path>, -sourcepath <path>
                  Specify where to find source files
    -subpackages <subpkglist>
                  Specify subpackages to recursively load
    --system <jdk>
                  Override location of system modules used for modular releases
    --upgrade-module-path <path>
                  Override location of upgradeable modules
    -verbose      Output messages about what Javadoc is doing
    --version     Print version information

Provided by the Standard doclet:
    --add-stylesheet <file>
                  Additional stylesheet file for the generated documentation
    --allow-script-in-comments
                  Allow JavaScript in options and comments
    -author       Include @author paragraphs
    -bottom <html-code>
                  Include bottom text for each page
    -charset <charset>
                  Charset for cross-platform viewing of generated documentation
    -d <directory>
                  Destination directory for output files
    -docencoding <name>
                  Specify the character encoding for the output
    -docfilessubdirs
                  Recursively copy doc-file subdirectories
    -doctitle <html-code>
                  Include title for the overview page
    -excludedocfilessubdir <name>:..
                  Exclude any doc-files subdirectories with given name
    -footer <html-code>
                  Include footer text for each page
    --frames      Enable the use of frames in the generated output
    -group <name> <g1>:<g2>...
                  Group specified elements together in overview page
    -header <html-code>
                  Include header text for each page
    -helpfile <file>
                  Include file that help link links to
    -html4        Generate HTML 4.01 output
    -html5        Generate HTML 5 output
    --javafx, -javafx
                  Enable JavaFX functionality
    -keywords     Include HTML meta tags with package, class and member info
    -link <url>   Create links to javadoc output at <url>
    -linkoffline <url1> <url2>
                  Link to docs at <url1> using package list at <url2>
    -linksource   Generate source in HTML
    --main-stylesheet <file>, -stylesheetfile <file>
                  File to change style of the generated documentation
    -nocomment    Suppress description and tags, generate only declarations
    -nodeprecated
                  Do not include @deprecated information
    -nodeprecatedlist
                  Do not generate deprecated list
    --no-frames   Disable the use of frames in the generated output (default)
    -nohelp       Do not generate help link
    -noindex      Do not generate index
    -nonavbar     Do not generate navigation bar
    -noqualifier <name1>:<name2>:..
                  Exclude the list of qualifiers from the output
    -nosince      Do not include @since information
    -notimestamp  Do not include hidden time stamp
    -notree       Do not generate class hierarchy
    --override-methods (detail|summary)
                  Document overridden methods in the detail or summary sections
    -overview <file>
                  Read overview documentation from HTML file
    -serialwarn   Generate warning about @serial tag
    -sourcetab <tab length>
                  Specify the number of spaces each tab takes up in the source
    -splitindex   Split index into one file per letter
    -tag <name>:<locations>:<header>
                  Specify single argument custom tags
    -taglet       The fully qualified name of Taglet to register
    -tagletpath   The path to Taglets
    -top <html-code>
                  Include top text for each page
    -use          Create class and package usage pages
    -version      Include @version paragraphs
    -windowtitle <text>
                  Browser window title for the documentation

GNU-style options may use = instead of whitespace to separate the name of an
option from its value.
Options (87)
OptionDescriptionSource
--add-modules module>(Root modules to resolve in addition to the initial modules, or all modules on the module path if <module> is ALL-MODULE-PATH.help
-bootclasspath pathOverride location of platform class files used for non-modular releaseshelp + man
-breakiteratorUses the internationalized sentence boundary of java.text.BreakIterator to determine the end of the first sentence in the main description of a package, class, or member for English.help + man
-doclet classSpecifies the class file that starts the doclet used in generating the documentation.help + man
-docletpath pathSpecifies the path to the doclet starting class file (specified with the -doclet option) and any JAR files it depends on.help + man
--enable-previewEnable preview language features.help
-encoding nameSpecifies the encoding name of the source files, such as EUCJIS/SJIS.help + man
-exclude pkglistUnconditionally excludes the specified packages and their subpackages from the list formed by -subpackages.help + man
--expand-requires valueInstructs the tool to expand the set of modules to be documented.help
-extdirs dirlistSpecifies the directories where extension classes reside.help + man
--help, -help, -?, -hDisplays the online help, which lists all of the javadoc and doclet command-line options.help + man
--help-extra, -XPrint a synopsis of nonstandard options and exithelp
-J flagPass <flag> directly to the runtime systemhelp
--limit-modules module>(Limit the universe of observable moduleshelp
-locale nameSpecifies the locale that the javadoc command uses when it generates documentation.help + man
--module module>(Document the specified module(s)help
--module-source-path pathSpecify where to find input source files for multiple moduleshelp
-packageShows only package, protected, and public classes and members.help + man
-privateShows all classes and members.help + man
-protectedShows only protected and public classes and members.help + man
-publicShows only public classes and members.help + man
-quietShuts off messages so that only the warnings and errors appear to make them easier to view.help + man
--release releaseProvide source compatibility with specified releasehelp
--show-members valueSpecifies which members (fields, methods, etc.) will be documented, where value can be one of "public", "protected", "package" or "private".help
--show-module-contents valueSpecifies the documentation granularity of module declarations.help
--show-packages valueSpecifies which modules packages will be documented.help
--show-types valueSpecifies which types (classes, interfaces, etc.) will be documented, where value can be one of "public", "protected", "package" or "private".help
-source releaseProvide source compatibility with specified releasehelp + man
-subpackages subpkglistGenerates documentation from source files in the specified packages and recursively in their subpackages.help + man
--system jdkOverride location of system modules used for modular releaseshelp
--upgrade-module-path pathOverride location of upgradeable moduleshelp
-verboseProvides more detailed messages while the javadoc command runs.help + man
--versionPrint version informationhelp
--add-stylesheet fileAdditional stylesheet file for the generated documentationhelp
--allow-script-in-commentsAllow JavaScript in options and commentshelp
-authorIncludes the @author text in the generated docs.help + man
-bottom html-codeSpecifies the text to be placed at the bottom of each output file.help + man
-charset charsetCharset for cross-platform viewing of generated documentationhelp + man
-d directorySpecifies the destination directory where the javadoc command saves the generated HTML files.help + man
-docencoding nameSpecifies the encoding of the generated HTML files.help + man
-docfilessubdirsRecursively copy doc-file subdirectorieshelp
-doctitle html-codeSpecifies the title to place near the top of the overview summary file.help + man
-excludedocfilessubdir name>:..Excludes any doc-files subdirectories with the specified names.help + man
-footer html-codeSpecifies the footer text to be placed at the bottom of each output file.help + man
--framesEnable the use of frames in the generated outputhelp
-header html-codeSpecifies the header text to be placed at the top of each output file.help + man
-helpfile fileSpecifies the path of an alternate help file pathfilename that the HELP link in the top and bottom navigation bars link to.help + man
-html4Generate HTML 4.01 outputhelp
-html5Generate HTML 5 outputhelp
--javafx, -javafxGenerates HTML documentation using the JavaFX extensions to the standard doclet.help + man
-keywordsAdds HTML keyword <META> tags to the generated file for each class.help + man
-link urlCreates links to existing Javadoc-generated documentation of externally referenced classes.help + man
-linksourceCreates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.help + man
-nocommentSuppresses the entire comment body, including the main description and all tags, and generate only declarations.help + man
-nodeprecatedPrevents the generation of any deprecated API in the documentation.help + man
-nodeprecatedlistPrevents the generation of the file that contains the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.help + man
--no-framesDisable the use of frames in the generated output (default)help
-nohelpOmits the HELP link in the navigation bars at the top and bottom of each page of output.help + man
-noindexOmits the index from the generated documents.help + man
-nonavbarPrevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages.help + man
-noqualifier name1>:<name2>:..Omits qualifying package names from class names in output.help + man
-nosinceOmits from the generated documents the Since sections associated with the @since tags.help + man
-notimestampSuppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page.help + man
-notreeOmits the class/interface hierarchy pages from the generated documents.help + man
--override-methods (detail|summary)Document overridden methods in the detail or summary sectionshelp
-overview fileSpecifies that the javadoc command should retrieve the text for the overview documentation from the source file specified by the path/filenameand place it on the Overview page (overview-summary.html).help + man
-serialwarnGenerates compile-time warnings for missing @serial tags.help + man
-splitindexSplits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols.help + man
-tag name>:<locations>:<headerEnables the javadoc command to interpret a simple, one-argument @tagname custom block tag in documentation comments.help + man
-taglet classSpecifies the class file that starts the taglet used in generating the documentation for that tag.help + man
-tagletpath tagletpathlistSpecifies the search paths for finding taglet class files.help + man
-top html-codeSpecifies the text to be placed at the top of each output file.help + man
-useIncludes one Use page for each documented class and package.help + man
-versionIncludes the @version text in the generated docs.help + man
-windowtitle textSpecifies the title to be placed in the HTML <title> tag.help + man
-Xdoclint none• (in the manual page but not in --help)man
-Xdoclintgroup :• (in the manual page but not in --help)man
-1.1Removed from Javadoc 1.4 with no replacement. (in the manual page but not in --help)man
-sourcepath sourcepathlistSpecifies the search paths for finding source files when passing package names or the -subpackages option into the javadoc command. (in the manual page but not in --help)man
-classpath classpathlistSpecifies the paths where the javadoc command searches for referenced classes These are the documented classes plus any classes referenced by those classes. (in the manual page but not in --help)man
-JflagPasses flag directly to the Java Runtime Environment (JRE) that runs the javadoc command. (in the manual page but not in --help)man
-title titleNo longer exists. (in the manual page but not in --help)man
-linkoffline extdocURLThis option is a variation of the -link option. (in the manual page but not in --help)man
-group groupheadingSeparates packages on the overview page into whatever groups you specify, one group per table. (in the manual page but not in --help)man
-stylesheet path/filenameSpecifies the path of an alternate HTML stylesheet file. (in the manual page but not in --help)man
-docfilesubdirsEnables deep copying of doc-files directories. (in the manual page but not in --help)man
-sourcetab tablengthSpecifies the number of spaces each tab uses in the source. (in the manual page but not in --help)man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.