Code Tools: apidiff: command-line help
Usage:
apidiff <options>
where <options> include:
--api <name>
Provides a name for an API to be compared and set the current API
for API-specific options that immediately follow on the command line.
--api-directory <api-directory>
Specifies the location of the documentation generated by javadoc for an API.
--class-path <class-path>
Specifies the class path for an API.
--compare-api-descriptions true|yes|on|false|no|off
Compares API descriptions (in files generated by javadoc) for elements found in each API.
--compare-api-descriptions-as-text true|yes|on|false|no|off
Compares the HTML for the API descriptions (in files generated by javadoc) as plain text
for elements found in each API.
--compare-doc-comments true|yes|on|false|no|off
Compares documentation comments (in source files) for elements found in each API.
--enable-preview
Enables preview features for an API.
--label <text>
Specifies a short string to identify an API in reports.
--module-path <module-path>
Specifies the module path for an API.
--module-source-path <module-source-path>
Specifies the module source path for an API.
--patch-module <module-name>=<path>
Specifies the path to patch a module for an API.
--release <jdk-version>
Specifies the Java SE release to be used for the platform classes for an API.
--source <jdk-version>
Specifies the version of the platform for an API.
--source-path <source-path>
Specifies the source path for an API.
--system <jdk-install-dir>
Specifies the system classes for an API.
--jdk-build <jdk-build>
Specifies the location of a JDK build from which to infer detailed
options for an API. The directory should contain a "configuration" as
understood by the 'configure' and 'make' commands used to build JDK.
--jdk-docs <name>
Specifies the name of the docs bundle to use for an API,
in conjunction with the --jdk-build option.
--access public|protected|package|private
Specifies the access for elements to be compared.
--exclude <pattern>
Specifies a pattern to match elements to be excluded from the comparison.
--include <pattern>
Specifies a pattern to match elements to be included in the comparison.
--output-directory <directory>, -d <directory>
Specifies the directory in which to write the report.
--title <text>
Specifies a title for the report.
--description <html>
Provides a short description to be included in the report.
--info-text <place>=<html>
Specifies text to be included at different positions in the report.
Positions include: top, header, footer, bottom.
--notes <file>
Specifies a file providing notes to be added into the report.
--main-stylesheet <file>
Specifies a alternative primary stylesheet to use in the generated report,
instead of the system default
--extra-stylesheet <file>
Specifies an additional stylesheet to use in the generated report.
--resource-files <file-or-directory>
Specifies resource files to be copied from an API directory
--help, -h, -help, -?
Shows this information.
--version, -v
Shows the version of the tool.
--verbose <flag>[,<flag>]*
Specifies level of verbose output.
Supported flags are all, none, or one of the following,
optionally preceded by -: module package type differences missing time options