OS Manuals

/usr/lib/jvm/java-1.9-openjdk/bin/javadoc

Oracle OpenJDK 9

From openjdk-9 9.0.4-r8 (os), captured 2026-11-05 by running javadoc --help (exit 0). permalink

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
    -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
                  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

Provided by the Standard doclet:
    --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 (default)
    -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
    -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
    -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
    -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
    -stylesheetfile <path>
                  File to change style of the generated documentation
    -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 (72)
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
-breakiteratorCompute first sentence with BreakIteratorhelp
-doclet classGenerate output via alternate doclethelp
-docletpath pathSpecify where to find doclet class fileshelp
-encoding nameSource file encoding namehelp
-exclude pkglistSpecify a list of packages to excludehelp
--expand-requires valueInstructs the tool to expand the set of modules to be documented.help
-extdirs dirlistOverride location of installed extensionshelp
--help, -helpDisplay command line options and exithelp
--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 nameLocale to be used, e.g. en_US or en_US_WINhelp
--module module>(Document the specified module(s)help
--module-source-path pathSpecify where to find input source files for multiple moduleshelp
-packageShow package/protected/public types and members.help
-privateShow all types and members.help
-protectedShow protected/public types and members (default).help
-publicShow only public types and members.help
-quietDo not display status messageshelp
--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
-subpackages subpkglistSpecify subpackages to recursively loadhelp
--system jdkOverride location of system modules used for modular releaseshelp
--upgrade-module-path pathOverride location of upgradeable moduleshelp
-verboseOutput messages about what Javadoc is doinghelp
--allow-script-in-commentsAllow JavaScript in options and commentshelp
-authorInclude @author paragraphshelp
-bottom html-codeInclude bottom text for each pagehelp
-charset charsetCharset for cross-platform viewing of generated documentationhelp
-d directoryDestination directory for output fileshelp
-docencoding nameSpecify the character encoding for the outputhelp
-docfilessubdirsRecursively copy doc-file subdirectorieshelp
-doctitle html-codeInclude title for the overview pagehelp
-excludedocfilessubdir name>:..Exclude any doc-files subdirectories with given namehelp
-footer html-codeInclude footer text for each pagehelp
--framesEnable the use of frames in the generated output (default)help
-header html-codeInclude header text for each pagehelp
-helpfile fileInclude file that help link links tohelp
-html4Generate HTML 4.01 outputhelp
-html5Generate HTML 5 outputhelp
--javafx, -javafxEnable javafx functionalityhelp
-keywordsInclude HTML meta tags with package, class and member infohelp
-link urlCreate links to javadoc output at <url>help
-linksourceGenerate source in HTMLhelp
-nocommentSuppress description and tags, generate only declarationshelp
-nodeprecatedDo not include @deprecated informationhelp
-nodeprecatedlistDo not generate deprecated listhelp
--no-framesDisable the use of frames in the generated outputhelp
-nohelpDo not generate help linkhelp
-noindexDo not generate indexhelp
-nonavbarDo not generate navigation barhelp
-noqualifier name1>:<name2>:..Exclude the list of qualifiers from the outputhelp
-nosinceDo not include @since informationhelp
-notimestampDo not include hidden time stamphelp
-notreeDo not generate class hierarchyhelp
-overview fileRead overview documentation from HTML filehelp
-serialwarnGenerate warning about @serial taghelp
-splitindexSplit index into one file per letterhelp
-stylesheetfile pathFile to change style of the generated documentationhelp
-tag name>:<locations>:<headerSpecify single argument custom tagshelp
-tagletThe fully qualified name of Taglet to registerhelp
-tagletpathThe path to Tagletshelp
-top html-codeInclude top text for each pagehelp
-useCreate class and package usage pageshelp
-versionInclude @version paragraphshelp
-windowtitle textBrowser window title for the documentationhelp

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