OS Manuals

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

Zulu 17 Java development kit (PSU stream)

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

Usage:
    javadoc [options] [packagenames] [sourcefiles] [@files]
where options include:
    @<file>       Read options and filenames from file
    --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>, -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
    -Werror       Report an error if any warnings occur

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
    -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
    -html5        Generate HTML 5 output. This option is no longer required.
    --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>
    --link-platform-properties <url>
                  Link to platform documentation URLs declared in properties file at <url>
    -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
    -nohelp       Do not generate help link
    -noindex      Do not generate index
    -nonavbar     Do not generate navigation bar
    --no-platform-links
                  Do not generate links to the platform documentation
    -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
    --since <release>(,<release>)*
                  Document new and deprecated API in the specified releases
    --since-label <text>
                  Provide text to use in the heading of the "New API" page
    -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 (93)
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 + man
-bootclasspath pathOverride location of platform class files used for non-modular releaseshelp + man
-breakiteratorComputes the first sentence with BreakIterator.help + man
-doclet classGenerates output by using an alternate doclet.help + man
-docletpath pathSpecifies where to find doclet class files (specified with the -doclet option) and any JAR files it depends on.help + man
--enable-previewEnable preview language features.help + man
-encoding nameSource file encoding namehelp + man
-exclude pkglistUnconditionally, excludes the specified packages and their subpackages from the list formed by -subpackages.help + man
--expand-requires valueInstructs the javadoc tool to expand the set of modules to be documented.help + man
-extdirs dirlistOverride location of installed extensionshelp + man
--help, -help, -?, -hPrints a synopsis of the standard options.help + man
--help-extra, -XPrint a synopsis of nonstandard options and exithelp + man
-J flagPass <flag> directly to the runtime systemhelp
--limit-modules module>(Limit the universe of observable moduleshelp + man
-locale nameSpecifies the locale that the javadoc tool uses when it generates documentation.help + man
--module module>(Document the specified module(s)help + man
--module-source-path pathSpecify where to find input source files for multiple moduleshelp + man
-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 the 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 + man
--show-members valueSpecifies which members (fields, methods, etc.) will be documented, where value can be one of "public", "protected", "package" or "private".help + man
--show-module-contents valueSpecifies the documentation granularity of module declarations, where value can be api or all.help + man
--show-packages valueSpecifies which modules packages are documented, where value can be exported or all packages.help + man
--show-types valueSpecifies which types (classes, interfaces, etc.) will be documented, where value can be one of "public", "protected", "package" or "private".help + 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 + man
--upgrade-module-path pathThe following options are the core javadoc options that are not equivalent to a corresponding javac option:help + man
-verboseProvides more detailed messages while the javadoc tool runs.help + man
--versionPrints version information.help + man
-WerrorReports an error if any warnings occur.help + man
--add-stylesheet fileAdds additional stylesheet file for the generated documentation.help + man
--allow-script-in-commentsAllow JavaScript in options and commentshelp + man
-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 tool saves the generated HTML files.help + man
-docencoding nameSpecifies the encoding of the generated HTML files.help + man
-docfilessubdirsRecursively copies doc-file subdirectories.help + man
-doctitle html-codeSpecifies the title to place near the top of the overview summary file.help + man
-excludedocfilessubdir name>:...Excludes any doc files sub directories with the given name.help + man
-footer html-codeSpecifies the footer text to be placed at the bottom of each output file.help + man
-header html-codeSpecifies the header text to be placed at the top of each output file.help + man
-helpfile fileIncludes the file that links to the HELP link in the top and bottom navigation bars .help + man
-html5This option is a no-op and is just retained for backwards compatibility.help + man
--javafx, -javafxEnables JavaFX functionality.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
--link-platform-properties urlLink to platform documentation URLs declared in properties file at <url>help
-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
-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
--no-platform-linksDo not generate links to the platform documentationhelp
-noqualifier name1>:<name2>:...Excludes the list of qualifiers from the 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 and interface hierarchy pages from the generated documents.help + man
--override-methods (detail|summary)Documents overridden methods in the detail or summary sections.help + man
-overview fileSpecifies that the javadoc tool should retrieve the text for the overview documentation from the source file specified by filename and place it on the Overview page (overview-summary.html).help + man
-serialwarnGenerates compile-time warnings for missing @serial tags.help + man
--since release>(Document new and deprecated API in the specified releaseshelp
--since-label textProvide text to use in the heading of the "New API" pagehelp
-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>:<headerSpecifies single argument custom tags.help + man
-taglet classSpecifies the fully qualified name of 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
-useCreates class and package usage pages.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
--class-path, -classpath, -cp• (in the manual page but not in --help)man
--module-path, -p• (in the manual page but not in --help)man
--source, -source• (in the manual page but not in --help)man
--source-path, -sourcepath• (in the manual page but not in --help)man
-JflagPasses flag directly to the Java Runtime Environment (JRE) that runs the javadoc tool. (in the manual page but not in --help)man
--add-exports• (in the manual page but not in --help)man
--add-reads• (in the manual page but not in --help)man
--patch-module• (in the manual page but not in --help)man
-Xmaxerrs• (in the manual page but not in --help)man
-XmaxwarnsThe following options are provided by the standard doclet. (in the manual page but not in --help)man
-group namep1:p2Group the specified packages together in the Overview page. (in the manual page but not in --help)man
-linkoffline url1This option is a variation of the -link option. (in the manual page but not in --help)man
--main-stylesheet, -stylesheetfile fileSpecifies the path of an alternate stylesheet file that contains the definitions for the CSS styles used in the generated documentation. (in the manual page but not in --help)man
--no-framesThis option is a no-op and is just retained for backwards compatibility. (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
-XdoclintEnables recommended checks for problems in documentation comments. (in the manual page but not in --help)man
-Xdocrootparent urlReplaces all @docRoot items followed by/.. (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.