javadoc:test-jar – Apache Maven Javadoc Plugin (original) (raw)

Bundles the Javadoc documentation for test Java code in a NON aggregator project into a jar using the standard Javadoc Tool.

Parameter Details

Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: 

<addStylesheets>
    <addStylesheet>resources/addstylesheet.css</addStylesheet>
</addStylesheets>

Capability to add additional dependencies to the javadoc classpath. Example:

geronimo-spec geronimo-spec-jta 1.0.1B-rc4

Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: 

<additionalJOptions>
    <additionalJOption>-J-Xmx1g </additionalJOption>
</additionalJOptions>

See also: additionalJOption

Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.

Deprecated.
the security fix this applied is not needed in Java 8+ or the most recent versions of JDK 6 and 7.

No-op.

Specifies whether to attach the generated artifact to the project helper.

Specifies whether the author text is included in the generated Javadocs.
See also: Doclet option author.

Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
See also: Javadoc option bootclasspath.

Specifies the artifacts where the boot classes reside.
Example:

my-groupId my-artifactId my-version

See Javadoc.
See also: Javadoc option bootclasspath

Specifies the text to be placed at the bottom of each output file.
If you want to use html, you have to put it in a CDATA section,
e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
See also: Doclet option bottom.

Uses the sentence break iterator to determine the end of the first sentence.
See also: Javadoc option breakiterator.

Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
See also: Doclet option charset.

No description.

Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.

Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved.

groupId artifactId classifier version

See also: detectLinks

List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
See also: includeDependencySources

List of included dependency-source patterns. Example: org.apache.maven:*
See also: includeDependencySources

Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
By default, the goal detects the Javadoc API link depending on the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
See also: links, javaApiLinks

Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
For instance, if the project has a dependency to Apache Commons Lang i.e.:

commons-lang commons-lang

The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
See also: links, dependencyLinks

Detect the links for all modules defined in the project.
If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's URLs. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
See also: offlineLinks

From jdk 23, javadoc now include some extra css, files which can increase the size of javadoc jar. This can be disabled using the option --no-fonts The javadoc plugin will add this option to disable extra files to be added per default. If you prefer the new font you must set to true the option disableNoFonts

When using legacyMode and aggregated javadoc, users may have a mix of Maven modules with module files and not. The javadoc need to be called with empty -sourcepath argument and files are in the argfile This usually need to be used with the following configuration

<sourceFileExcludes> <sourceFileExclude>**\/module-info.java</sourceFileExclude> </sourceFileExcludes>

Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
See also: Doclet option docencoding.

Enables deep copying of the **/doc-files directories and the specific resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
See also: Doclet option docfilessubdirs., excludedocfilessubdir, javadocDirectory

Specifies the class file that starts the doclet used in generating the documentation.
See also: Javadoc option doclet.

Specifies the artifact containing the doclet starting class file (specified with the doclet option).
Example:

com.sun.tools.doclets doccheck 1.2b2

See Javadoc.

See also: Javadoc option docletpath.

Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
Example:

com.sun.tools.doclets doccheck 1.2b2

See Javadoc.

See also: Javadoc option docletpath.

Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
See also: Javadoc option docletpath.

Specifies the title to be placed near the top of the overview summary file.
See also: Doclet option doctitle.

Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
See also: Javadoc option encoding.

Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).

Wildcards work as followed:

Example:

.internal:org.acme.exclude1.:org.acme.exclude2

See also: Javadoc option exclude.

Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
See also: Doclet option excludedocfilessubdir., docfilessubdirs

Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
See also: Javadoc option extdirs.

Specifies if the build will fail if there are errors during javadoc execution or not.

Specifies if the build will fail if there are warning during javadoc execution or not.

Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.

Specifies the footer text to be placed at the bottom of each output file.
See also: Doclet option footer.

Forces the Javadoc JVM locale to be java.util.Locale.ROOT

. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.

Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
Example:

Core Packages java.lang*:java.util Extension Packages   javax.*

Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
See also: Doclet option group., org.apache.maven.plugins.javadoc.options.Group

Specifies the header text to be placed at the top of each output file.
See also: Doclet option header.

Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
Note: could be in conflict with .
The helpfile could be an absolute File path.
Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:

path/to/your/resource/yourhelp-doc.html

Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.

org.apache.maven.plugins maven-javadoc-plugin path/to/your/resource/yourhelp-doc.html ... groupId artifactId version ...

Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
See also: Doclet option helpfile.

Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.

Deprecated.
if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies

Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
See also: includeDependencySources

Specifies the directory where the generated jar file will be put.

Use this parameter only if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example:

api_1.5

https://docs.oracle.com/javase/1.5.0/docs/api/

api_1.8

https://docs.oracle.com/javase/8/docs/api/

api_9

https://docs.oracle.com/javase/9/docs/api/

Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
Could be used in addition of docfilessubdirs parameter.
See docfilessubdirs.
See also: docfilessubdirs

Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.

Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".

Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.

Examples:

(see Guide to Toolchains for more info)

` ... 11

... 1.8 zulu `

note: requires at least Maven 3.3.1

Adds HTML meta keyword tags to the generated file for each class.
See also: Doclet option keywords.

Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.

Creates links to existing javadoc-generated documentation of external referenced classes.

Notes:

  1. This option is ignored if the plugin is run in offline mode using the <offline> setting or by specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
  2. All given links should have a fetchable /package-list or /element-list (since Java 10). For instance: https://docs.oracle.com/en/java/javase/17/docs/api will be used because `https://docs.oracle.com/en/java/javase/17/docs/api/element-list` exists.
  3. If detectLinks is defined, the links between the project dependencies are automatically added.
  4. If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.

See also: Doclet option link

Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
See also: Doclet option linksource/a>.

Specifies the locale that javadoc uses when generating documentation.
See also: Javadoc option locale.

Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.

Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.

Suppress the entire comment body, including the main description and all tags, generating only declarations.
See also: Doclet option nocomment.

Prevents the generation of any deprecated API at all in the documentation.
See also: Doclet option nodeprecated.

Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
See also: Doclet option nodeprecatedlist.

Omits the HELP link in the navigation bars at the top and bottom of each page of output.
Note: could be in conflict with helpfile.
See also: Doclet option nohelp.

Omits the index from the generated docs.
Note: could be in conflict with splitindex
See also: Doclet option noindex.

Omits the entire overview page from the generated docs.
Note: could be in conflict with overview.
Standard Doclet undocumented option.

Omits qualifying package name from ahead of class names in output. Example:

all or packagename1:packagename2

See also: Doclet option noqualifier.

Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.

Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
See also: Doclet option notimestamp.

Omits the class/interface hierarchy pages from the generated docs.
See also: Doclet option notree

Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.

This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
Example:

https://docs.oracle.com/javase/1.5.0/docs/api/ ../javadoc/jdk-5.0/

Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline

Deprecated.
No longer used.

This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
See also: Javadoc option 1.1.

The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.
See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).

Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
Note: could be in conflict with nooverview.
See also: Javadoc option overview.

Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).
Since Java 5.0.
See also: Javadoc option quiet.

A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
Example:

external.group.id external-resources 1.0

See Javadoc.

Specifies the access level for classes and members to show in the Javadocs. Possible values are:

See also: Javadoc options private, protected, public and package

Specifies whether the Javadoc generation should be skipped.

Comma separated list of modules (can be regular expression) in the format ([group:]artifactId) to not add in aggregated javadoc

Provide source compatibility with specified release. Since JDK 9 rather use release.
See also: Javadoc option source.

Directory where unpacked project sources / test-sources should be cached.
See also: includeDependencySources

exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.

Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.

Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
See also: Javadoc option sourcepath.

Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
See also: Doclet option sourcetab

Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
Note: could be in conflict with noindex.
See also: Doclet option splitindex.

Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.

Deprecated.
This is no longer evaluated, instead use addStylesheets to customize the CSS.

Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
Possible values: maven`` or `java`. ``

Specifies the path of an alternate HTML stylesheet file.
The stylesheetfile could be an absolute File path.
Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:

path/to/your/resource/yourstylesheet.css

Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.

org.apache.maven.plugins maven-javadoc-plugin path/to/your/resource/yourstylesheet.css ... groupId artifactId version ...

Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
See also: Doclet option stylesheetfile.

Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
See also: Javadoc option subpackages.

Specifies the class file that starts the taglet used in generating the documentation for that tag.
See also: Doclet option taglet.

Specifies the Taglet artifact containing the taglet class files (.class).
Example:

com.sun.tools.doclets.ToDoTaglet package.to.AnotherTagletClass ... group-Taglet artifact-Taglet version-Taglet

See Javadoc.
See also: Doclet option tagletpath.

Specifies several Taglet artifacts containing the taglet class files (.class). These taglet class names will be auto-detected and so no need to specify them.
Example:

group-Taglet artifact-Taglet version-Taglet ...

See Javadoc.
See also: Doclet options taglet and tagletpath

Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
See also: Doclet option tagletpath.

Enables the Javadoc tool to interpret multiple taglets.
Example:

com.sun.tools.doclets.ToDoTaglet group-Taglet artifact-Taglet version-Taglet

See Javadoc.

See also: Doclet options taglet and tagletpath

Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
Example:

todo a To Do:

Note: the placement should be a combinaison of Xaoptcmf letters:

See Javadoc.
See also: Doclet option tag.

No description.

Specifies the Test title to be placed near the top of the overview summary file.
See also: Doclet option doctitle.

Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).

Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
See also: Doclet option overview.

Includes one "Use" page for each documented class and package.
See also: Doclet option use.

Set this to true to enable the use of the defaultManifestFile.

Specifies to use the options provided by the Standard Doclet for a custom doclet.
Example:

com.sun.tools.doclets doccheck 1.2b2 true

Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.

Provides more detailed messages while javadoc is running.
See also: Javadoc option verbose.

Includes the given version text in the generated docs.
See also: Doclet option version.