From 9d202d5efbf8213dc19e8fad37e44f3569e29af76ff238369ed48851e402d6b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrian=20Schr=C3=B6ter?= Date: Thu, 20 Feb 2025 09:52:24 +0100 Subject: [PATCH] Sync from SUSE:SLFO:Main maven-javadoc-plugin revision 97eebac10ce58be11b3076b74514e060 --- _service | 15 + maven-javadoc-plugin-3.11.2.tar.xz | 3 + maven-javadoc-plugin-3.6.0-source-release.zip | 3 - ...n-javadoc-plugin-bootstrap-resources.patch | 18493 ++++++++-------- maven-javadoc-plugin-build.xml | 7 +- maven-javadoc-plugin.changes | 134 +- maven-javadoc-plugin.spec | 33 +- no-override.patch | 10 - reproducible-from-environment.patch | 17 + stale-data-encoding.patch | 18 +- 10 files changed, 9542 insertions(+), 9191 deletions(-) create mode 100644 _service create mode 100644 maven-javadoc-plugin-3.11.2.tar.xz delete mode 100644 maven-javadoc-plugin-3.6.0-source-release.zip delete mode 100644 no-override.patch create mode 100644 reproducible-from-environment.patch diff --git a/_service b/_service new file mode 100644 index 0000000..1178ccb --- /dev/null +++ b/_service @@ -0,0 +1,15 @@ + + + git + https://github.com/apache/maven-javadoc-plugin.git + maven-javadoc-plugin-3.11.2 + maven-javadoc-plugin-* + @PARENT_TAG@ + maven-javadoc-plugin-(.*) + + + *.tar + xz + + + diff --git a/maven-javadoc-plugin-3.11.2.tar.xz b/maven-javadoc-plugin-3.11.2.tar.xz new file mode 100644 index 0000000..bac8802 --- /dev/null +++ b/maven-javadoc-plugin-3.11.2.tar.xz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cfafd165e65ddc70ebe90d74700e50d5125b56f6f71dbb88ba1e172086ddcc6d +size 819928 diff --git a/maven-javadoc-plugin-3.6.0-source-release.zip b/maven-javadoc-plugin-3.6.0-source-release.zip deleted file mode 100644 index ebf8124..0000000 --- a/maven-javadoc-plugin-3.6.0-source-release.zip +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:d799694aeb45751893878c6ee119a1b64ff428a1f5e90ae55793934148498907 -size 3609104 diff --git a/maven-javadoc-plugin-bootstrap-resources.patch b/maven-javadoc-plugin-bootstrap-resources.patch index 6e23bff..7c13e11 100644 --- a/maven-javadoc-plugin-bootstrap-resources.patch +++ b/maven-javadoc-plugin-bootstrap-resources.patch @@ -1,10 +1,9 @@ -diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml ---- maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml 1970-01-01 01:00:00.000000000 +0100 -+++ maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml 2023-09-20 09:00:08.850415621 +0200 -@@ -0,0 +1,13453 @@ +--- a/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml 1970-01-01 01:00:00.000000000 +0100 ++++ b/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml 2024-11-04 11:07:28.436706316 +0100 +@@ -0,0 +1,15697 @@ + + -+ ++ + + + ${project.name} @@ -16,7 +15,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + aggregate -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ ++Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + +Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project. + @@ -36,12 +36,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -49,7 +57,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -57,7 +66,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -65,15 +75,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -81,14 +83,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -96,7 +99,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -104,28 +108,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -133,31 +146,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -165,15 +182,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ 2.1 -+ false -+ true -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -181,7 +190,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -189,7 +200,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -197,35 +210,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -233,14 +257,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -248,42 +277,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -291,7 +333,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -299,35 +341,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -335,17 +393,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -353,7 +411,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -361,7 +426,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -369,7 +437,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -377,15 +445,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -393,7 +465,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -401,42 +474,52 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + name @@ -444,49 +527,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -494,21 +586,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -516,14 +613,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -531,29 +632,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -561,14 +667,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -576,14 +685,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -591,14 +704,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -606,21 +713,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -628,7 +744,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -636,14 +752,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -651,30 +770,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -683,14 +804,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -698,36 +822,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -735,7 +867,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -743,14 +878,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -758,14 +897,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -773,14 +926,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -788,7 +943,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -796,28 +952,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -831,7 +990,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -844,12 +1002,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -880,13 +1039,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + ${quiet} + -+ ${reportOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + ${show} @@ -918,7 +1076,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + aggregate-jar -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. ++ ++Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + +Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. + @@ -931,7 +1090,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + package + compile -+ org.apache.maven.plugins.javadoc.AggregatorJavadocJar ++ org.apache.maven.plugins.javadoc.AggregatorJavadocJarMojo + java + per-lookup + once-per-session @@ -939,12 +1098,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -952,7 +1119,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -960,7 +1128,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -968,15 +1137,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -984,7 +1145,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + archive @@ -992,19 +1153,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>. + + + attach + boolean + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ Specifies whether to attach the generated artifact to the project helper. + + + @@ -1012,7 +1168,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -1020,7 +1177,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -1028,28 +1186,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + classifier @@ -1057,10 +1224,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ + + + debug @@ -1068,42 +1232,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.io.File -+ No reason given -+ false -+ true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -1111,7 +1268,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -1119,7 +1278,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -1127,35 +1288,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -1163,14 +1335,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -1178,42 +1355,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -1221,7 +1411,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -1229,45 +1419,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ 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. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -1275,27 +1478,24 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + jarOutputDirectory + java.lang.String + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the directory where the generated jar file will be put. + + + javaApiLinks @@ -1303,7 +1503,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -1311,7 +1518,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -1319,7 +1529,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -1327,15 +1537,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -1343,7 +1557,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -1351,84 +1566,103 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -1436,21 +1670,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -1458,14 +1697,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -1473,29 +1716,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -1503,14 +1751,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -1518,14 +1769,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -1533,7 +1788,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -1541,21 +1797,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -1563,7 +1828,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -1571,14 +1836,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -1586,30 +1854,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -1618,14 +1888,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -1633,36 +1906,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -1670,7 +1951,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -1678,14 +1962,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -1693,14 +1981,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -1708,14 +2010,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useDefaultManifestFile @@ -1723,9 +2027,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ Set this to true to enable the use of the defaultManifestFile. + + + @@ -1734,7 +2036,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -1742,28 +2045,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -1778,7 +2084,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${maven.javadoc.classifier} + ${debug} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -1791,13 +2096,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} + ${project.build.finalName} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -1828,7 +2134,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} @@ -1866,7 +2172,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + aggregate-no-fork -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + compile + false + true @@ -1882,12 +2188,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -1895,7 +2209,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -1903,7 +2218,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -1911,15 +2227,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -1927,14 +2235,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -1942,7 +2251,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -1950,28 +2260,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -1979,31 +2298,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -2011,15 +2334,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ 2.1 -+ false -+ true -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -2027,7 +2342,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -2035,7 +2352,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -2043,35 +2362,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -2079,14 +2409,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -2094,42 +2429,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -2137,7 +2485,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -2145,35 +2493,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -2181,17 +2545,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -2199,7 +2563,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -2207,7 +2578,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -2215,7 +2589,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -2223,15 +2597,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -2239,7 +2617,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -2247,42 +2626,52 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + name @@ -2290,49 +2679,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -2340,21 +2738,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -2362,14 +2765,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -2377,29 +2784,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -2407,14 +2819,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -2422,14 +2837,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -2437,14 +2856,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -2452,21 +2865,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -2474,7 +2896,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -2482,14 +2904,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -2497,30 +2922,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -2529,14 +2956,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -2544,36 +2974,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -2581,7 +3019,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -2589,14 +3030,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -2604,14 +3049,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -2619,14 +3078,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -2634,7 +3095,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -2642,28 +3104,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -2677,7 +3142,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -2690,12 +3154,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -2726,13 +3191,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + ${quiet} + -+ ${reportOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + ${show} @@ -2764,7 +3228,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + fix -+ Fix Javadoc documentation and tags for the Java code for the project. ++ Fix Javadoc documentation and tags for the Java code for the project. ++See also: Where Tags Can Be Used <https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used> + compile + false + true @@ -2785,119 +3250,139 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Version to compare the current code against using the Clirr Maven Plugin <https://www.mojohaus.org/clirr-maven-plugin/>. ++See defaultSince. + + + defaultAuthor + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @author. + + + defaultSince + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @since. + + + defaultVersion + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @version. + + + encoding + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used. + + + excludes + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated excludes Java files, i.e. **/*Test.java. + + + fixClassComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the classes or interfaces Javadoc comments according the level. + + + fixFieldComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the fields Javadoc comments according the level. + + + fixMethodComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the methods Javadoc comments according the level. + + + fixTags + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are: ++* all (fix all Javadoc tags) ++* author (fix only @author tag) ++* version (fix only @version tag) ++* since (fix only @since tag) ++* param (fix only @param tag) ++* return (fix only @return tag) ++* throws (fix only @throws tag) ++* link (fix only @link tag) + + + force + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Forcing the goal execution i.e. skip warranty messages (not recommended). + + + ignoreClirr + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to ignore or not Clirr. + + + includes + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated includes Java files, i.e. **/*Test.java. ++ ++Note: default value is **\/*.java. + + + level + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: private, protected, public, package options for Javadoc <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + outputDirectory + java.io.File + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Output directory where Java classes will be rewritten. + + + removeUnknownThrows + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ ++Flag to remove throws tags from unknown classes. ++ ++NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness. ++ + + + + ${comparisonVersion} -+ ${defaultAuthor} ++ ${defaultAuthor} + ${defaultSince} -+ ${defaultVersion} ++ ${defaultVersion} + ${encoding} + ${excludes} + ${fixClassComment} @@ -2922,7 +3407,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + false + true -+ org.apache.maven.plugins.javadoc.HelpMojo ++ org.apache.maven.plugins.maven_javadoc_plugin.HelpMojo + java + per-lookup + once-per-session @@ -2933,32 +3418,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + boolean + false + true -+ Display help information on maven-javadoc-plugin. -+Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. ++ If true, display all settable properties for each goal. + + + goal + java.lang.String + false + true -+ Display help information on maven-javadoc-plugin. -+Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. ++ The name of the goal for which to show help. If unspecified, all goals will be displayed. + + + indentSize + int + false + true -+ Display help information on maven-javadoc-plugin. -+Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. ++ The number of spaces per indentation level, should be positive. + + + lineLength + int + false + true -+ Display help information on maven-javadoc-plugin. -+Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. ++ The maximum length of a display line, should be positive. + + + @@ -2970,7 +3451,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + jar -+ Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool. ++ Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + compile + false + true @@ -2979,7 +3460,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + true + package -+ org.apache.maven.plugins.javadoc.JavadocJar ++ org.apache.maven.plugins.javadoc.JavadocJarMojo + java + per-lookup + once-per-session @@ -2987,12 +3468,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -3000,7 +3489,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -3008,7 +3498,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -3016,15 +3507,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -3032,7 +3515,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + archive @@ -3040,19 +3523,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>. + + + attach + boolean + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ Specifies whether to attach the generated artifact to the project helper. + + + @@ -3060,7 +3538,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -3068,7 +3547,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -3076,28 +3556,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + classifier @@ -3105,10 +3594,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ + + + debug @@ -3116,42 +3602,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.io.File -+ No reason given -+ false -+ true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -3159,7 +3638,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -3167,7 +3648,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -3175,35 +3658,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -3211,14 +3705,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -3226,42 +3725,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -3269,7 +3781,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -3277,45 +3789,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ 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. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -3323,27 +3848,24 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + jarOutputDirectory + java.lang.String + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the directory where the generated jar file will be put. + + + javaApiLinks @@ -3351,7 +3873,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -3359,7 +3888,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -3367,7 +3899,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -3375,15 +3907,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -3391,7 +3927,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -3399,84 +3936,103 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -3484,21 +4040,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -3506,14 +4067,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -3521,29 +4086,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -3551,14 +4121,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -3566,14 +4139,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -3581,7 +4158,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -3589,21 +4167,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -3611,7 +4198,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -3619,14 +4206,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -3634,30 +4224,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -3666,14 +4258,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -3681,36 +4276,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -3718,7 +4321,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -3726,14 +4332,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -3741,14 +4351,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -3756,14 +4380,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useDefaultManifestFile @@ -3771,9 +4397,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ Set this to true to enable the use of the defaultManifestFile. + + + @@ -3782,7 +4406,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -3790,28 +4415,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -3826,7 +4454,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${maven.javadoc.classifier} + ${debug} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -3839,13 +4466,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} + ${project.build.finalName} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -3876,7 +4504,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} @@ -3914,7 +4542,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + javadoc -+ Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool. ++ Generates documentation for the Java code in a NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. ++See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html> + compile + false + true @@ -3931,12 +4560,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -3944,7 +4581,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -3952,7 +4590,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -3960,15 +4599,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -3976,14 +4607,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -3991,7 +4623,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -3999,28 +4632,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -4028,31 +4670,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -4060,15 +4706,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ 2.1 -+ false -+ true -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -4076,7 +4714,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -4084,7 +4724,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -4092,35 +4734,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -4128,14 +4781,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -4143,42 +4801,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -4186,7 +4857,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -4194,35 +4865,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -4230,17 +4917,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -4248,7 +4935,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -4256,7 +4950,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -4264,7 +4961,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -4272,15 +4969,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -4288,7 +4989,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -4296,42 +4998,52 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + name @@ -4339,49 +5051,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -4389,21 +5110,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -4411,14 +5137,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -4426,29 +5156,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -4456,14 +5191,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -4471,14 +5209,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -4486,14 +5228,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -4501,21 +5237,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -4523,7 +5268,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -4531,14 +5276,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -4546,30 +5294,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -4578,14 +5328,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -4593,36 +5346,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -4630,7 +5391,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -4638,14 +5402,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -4653,14 +5421,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -4668,14 +5450,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -4683,7 +5467,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -4691,28 +5476,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -4726,7 +5514,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -4739,12 +5526,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -4775,13 +5563,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + ${quiet} + -+ ${reportOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + ${show} @@ -4813,7 +5600,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + javadoc-no-fork -+ Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. Note that this goal does require generation of sources before site generation, e.g. by invoking mvn clean deploy site. ++See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>, Javadoc Options <http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options> + compile + false + true @@ -4829,12 +5617,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -4842,7 +5638,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -4850,7 +5647,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -4858,15 +5656,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -4874,14 +5664,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -4889,7 +5680,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -4897,28 +5689,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -4926,31 +5727,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -4958,15 +5763,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ 2.1 -+ false -+ true -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -4974,7 +5771,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -4982,7 +5781,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -4990,35 +5791,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -5026,14 +5838,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -5041,42 +5858,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -5084,7 +5914,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -5092,35 +5922,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -5128,17 +5974,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -5146,7 +5992,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -5154,7 +6007,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -5162,7 +6018,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -5170,15 +6026,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -5186,7 +6046,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -5194,42 +6055,52 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + name @@ -5237,49 +6108,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -5287,21 +6167,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -5309,14 +6194,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -5324,29 +6213,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -5354,14 +6248,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -5369,14 +6266,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -5384,14 +6285,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -5399,21 +6294,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -5421,7 +6325,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -5429,14 +6333,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -5444,30 +6351,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -5476,14 +6385,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -5491,36 +6403,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -5528,7 +6448,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -5536,14 +6459,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -5551,14 +6478,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -5566,14 +6507,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -5581,7 +6524,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -5589,28 +6533,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -5624,7 +6571,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -5637,12 +6583,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -5673,13 +6620,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + ${quiet} + -+ ${reportOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + ${show} @@ -5711,7 +6657,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + resource-bundle -+ Bundle {@link AbstractJavadocMojo#javadocDirectory}, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself. ++ Bundle javadocDirectory, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself. + compile + false + true @@ -5728,12 +6674,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -5741,7 +6695,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -5749,7 +6704,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -5757,15 +6713,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -5773,14 +6721,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -5788,7 +6737,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -5796,28 +6746,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -5825,31 +6784,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -5857,7 +6820,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -5865,7 +6830,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -5873,35 +6840,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -5909,14 +6887,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -5924,42 +6907,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -5967,7 +6963,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -5975,35 +6971,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -6011,17 +7023,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -6029,7 +7041,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -6037,7 +7056,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -6045,7 +7067,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -6053,15 +7075,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -6069,7 +7095,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -6077,84 +7104,103 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -6162,21 +7208,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -6184,14 +7235,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -6199,29 +7254,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -6229,14 +7289,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -6244,14 +7307,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -6259,7 +7326,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -6267,21 +7335,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -6289,7 +7366,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -6297,14 +7374,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -6312,30 +7392,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -6344,14 +7426,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -6359,36 +7444,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -6396,7 +7489,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -6404,14 +7500,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -6419,14 +7519,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -6434,14 +7548,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -6449,7 +7565,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -6457,28 +7574,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -6503,12 +7623,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -6538,7 +7659,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} @@ -6575,7 +7696,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-aggregate -+ Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool. ++ ++Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + +Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project. + @@ -6595,12 +7717,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -6608,7 +7738,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -6616,7 +7747,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -6624,15 +7756,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -6640,14 +7764,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -6655,7 +7780,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -6663,28 +7789,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -6692,31 +7827,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -6724,14 +7863,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -6739,7 +7871,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -6747,7 +7881,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -6755,35 +7891,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -6791,14 +7938,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -6806,42 +7958,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -6849,7 +8014,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -6857,35 +8022,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -6893,17 +8074,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -6911,7 +8092,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -6919,7 +8107,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -6927,7 +8118,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -6935,15 +8126,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -6951,7 +8146,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -6959,42 +8155,52 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + name @@ -7002,49 +8208,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -7052,21 +8267,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -7074,14 +8294,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -7089,29 +8313,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -7119,14 +8348,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -7134,14 +8366,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -7149,14 +8385,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -7164,21 +8394,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -7186,7 +8425,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -7194,14 +8433,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -7209,30 +8451,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -7241,14 +8485,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -7256,36 +8503,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -7293,7 +8548,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -7301,14 +8559,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -7316,14 +8578,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testDescription @@ -7332,7 +8608,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testDoctitle @@ -7341,7 +8617,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -7350,7 +8627,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). ++Could be used in addition of docfilessubdirs parameter. ++See docfilessubdirs. + + + testName @@ -7359,7 +8638,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testOverview @@ -7368,7 +8647,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -7377,7 +8657,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -7385,14 +8666,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -7400,7 +8683,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -7408,28 +8692,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -7443,7 +8730,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -7456,12 +8742,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -7492,13 +8779,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + ${quiet} + -+ ${reportTestOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + ${show} @@ -7536,7 +8822,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-aggregate-jar -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. ++ ++Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + +Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. + @@ -7549,7 +8836,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + package + test-compile -+ org.apache.maven.plugins.javadoc.AggregatorTestJavadocJar ++ org.apache.maven.plugins.javadoc.AggregatorTestJavadocJarMojo + java + per-lookup + once-per-session @@ -7557,12 +8844,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -7570,7 +8865,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -7578,7 +8874,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -7586,15 +8883,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -7602,7 +8891,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + archive @@ -7610,19 +8899,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>. + + + attach + boolean + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ Specifies whether to attach the generated artifact to the project helper. + + + @@ -7630,7 +8914,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -7638,7 +8923,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -7646,28 +8932,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + classifier @@ -7675,10 +8970,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ + + + debug @@ -7686,42 +8978,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.io.File -+ No reason given -+ false -+ true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -7729,7 +9014,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -7737,7 +9024,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -7745,35 +9034,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -7781,14 +9081,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -7796,42 +9101,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -7839,7 +9157,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -7847,45 +9165,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ 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. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -7893,27 +9224,24 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + jarOutputDirectory + java.lang.String + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the directory where the generated jar file will be put. + + + javaApiLinks @@ -7921,7 +9249,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -7929,7 +9264,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -7937,7 +9275,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -7945,15 +9283,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -7961,7 +9303,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -7969,84 +9312,103 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -8054,21 +9416,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -8076,14 +9443,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -8091,31 +9462,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory + java.io.File + true + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -8123,14 +9497,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -8138,14 +9515,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -8153,7 +9534,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -8161,21 +9543,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -8183,7 +9574,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -8191,14 +9582,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -8206,30 +9600,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -8238,14 +9634,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -8253,36 +9652,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -8290,7 +9697,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -8298,14 +9708,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -8313,14 +9727,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testClassifier @@ -8328,10 +9756,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ + + + testDoctitle @@ -8340,10 +9765,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -8352,10 +9775,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). + + + testOverview @@ -8364,10 +9784,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -8376,10 +9794,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -8387,14 +9803,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useDefaultManifestFile @@ -8402,9 +9820,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ Set this to true to enable the use of the defaultManifestFile. + + + @@ -8413,7 +9829,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -8421,28 +9838,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -8457,7 +9877,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${maven.javadoc.classifier} + ${debug} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -8470,13 +9889,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} + ${project.build.finalName} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -8507,7 +9927,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ++ + + ${overview} + ${packagesheader} @@ -8550,7 +9970,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-aggregate-no-fork -+ Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool. ++ Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + test + false + true @@ -8566,12 +9986,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -8579,7 +10007,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -8587,7 +10016,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -8595,15 +10025,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -8611,14 +10033,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -8626,7 +10049,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -8634,28 +10058,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -8663,31 +10096,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -8695,14 +10132,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -8710,7 +10140,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -8718,7 +10150,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -8726,35 +10160,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -8762,14 +10207,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -8777,42 +10227,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -8820,7 +10283,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -8828,35 +10291,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -8864,17 +10343,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -8882,7 +10361,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -8890,7 +10376,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -8898,7 +10387,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -8906,15 +10395,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -8922,7 +10415,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -8930,42 +10424,52 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + name @@ -8973,49 +10477,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -9023,21 +10536,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -9045,14 +10563,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -9060,29 +10582,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -9090,14 +10617,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -9105,14 +10635,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -9120,14 +10654,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -9135,21 +10663,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -9157,7 +10694,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -9165,14 +10702,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -9180,30 +10720,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -9212,14 +10754,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -9227,36 +10772,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -9264,7 +10817,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -9272,14 +10828,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -9287,14 +10847,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testDescription @@ -9303,7 +10877,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testDoctitle @@ -9312,7 +10886,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -9321,7 +10896,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). ++Could be used in addition of docfilessubdirs parameter. ++See docfilessubdirs. + + + testName @@ -9330,7 +10907,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testOverview @@ -9339,7 +10916,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -9348,7 +10926,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -9356,14 +10935,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -9371,7 +10952,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -9379,28 +10961,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -9414,7 +10999,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -9427,12 +11011,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -9463,13 +11048,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + ${quiet} + -+ ${reportTestOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + ${show} @@ -9507,7 +11091,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-fix -+ Fix Javadoc documentation and tags for the Test Java code for the project. ++ Fix Javadoc documentation and tags for the Test Java code for the project. ++See also: Where Tags Can Be Used <https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used> + test + false + true @@ -9528,119 +11113,139 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Version to compare the current code against using the Clirr Maven Plugin <https://www.mojohaus.org/clirr-maven-plugin/>. ++See defaultSince. + + + defaultAuthor + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @author. + + + defaultSince + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @since. + + + defaultVersion + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @version. + + + encoding + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used. + + + excludes + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated excludes Java files, i.e. **/*Test.java. + + + fixClassComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the classes or interfaces Javadoc comments according the level. + + + fixFieldComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the fields Javadoc comments according the level. + + + fixMethodComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the methods Javadoc comments according the level. + + + fixTags + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are: ++* all (fix all Javadoc tags) ++* author (fix only @author tag) ++* version (fix only @version tag) ++* since (fix only @since tag) ++* param (fix only @param tag) ++* return (fix only @return tag) ++* throws (fix only @throws tag) ++* link (fix only @link tag) + + + force + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Forcing the goal execution i.e. skip warranty messages (not recommended). + + + ignoreClirr + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to ignore or not Clirr. + + + includes + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated includes Java files, i.e. **/*Test.java. ++ ++Note: default value is **\/*.java. + + + level + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: private, protected, public, package options for Javadoc <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + outputDirectory + java.io.File + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Output directory where Java classes will be rewritten. + + + removeUnknownThrows + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ ++Flag to remove throws tags from unknown classes. ++ ++NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness. ++ + + + + ${comparisonVersion} -+ ${defaultAuthor} ++ ${defaultAuthor} + ${defaultSince} -+ ${defaultVersion} ++ ${defaultVersion} + ${encoding} + ${excludes} + ${fixClassComment} @@ -9657,7 +11262,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-jar -+ Bundles the Javadoc documentation for test Java code in an NON aggregator project into a jar using the standard Javadoc Tool. ++ Bundles the Javadoc documentation for test Java code in an NON aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + test + false + true @@ -9666,7 +11271,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + true + package -+ org.apache.maven.plugins.javadoc.TestJavadocJar ++ org.apache.maven.plugins.javadoc.TestJavadocJarMojo + java + per-lookup + once-per-session @@ -9674,12 +11279,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -9687,7 +11300,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -9695,7 +11309,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -9703,15 +11318,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -9719,7 +11326,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + archive @@ -9727,19 +11334,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>. + + + attach + boolean + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ Specifies whether to attach the generated artifact to the project helper. + + + @@ -9747,7 +11349,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -9755,7 +11358,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -9763,28 +11367,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + classifier @@ -9792,10 +11405,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ + + + debug @@ -9803,42 +11413,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.io.File -+ No reason given -+ false -+ true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -9846,7 +11449,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -9854,7 +11459,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -9862,35 +11469,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -9898,14 +11516,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -9913,42 +11536,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -9956,7 +11592,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -9964,45 +11600,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ 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. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -10010,27 +11659,24 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + jarOutputDirectory + java.lang.String + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the directory where the generated jar file will be put. + + + javaApiLinks @@ -10038,7 +11684,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -10046,7 +11699,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -10054,7 +11710,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -10062,15 +11718,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -10078,7 +11738,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -10086,84 +11747,103 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -10171,21 +11851,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -10193,14 +11878,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -10208,31 +11897,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory + java.io.File + true + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -10240,14 +11932,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -10255,14 +11950,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -10270,7 +11969,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -10278,21 +11978,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -10300,7 +12009,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -10308,14 +12017,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -10323,30 +12035,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -10355,14 +12069,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -10370,36 +12087,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -10407,7 +12132,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -10415,14 +12143,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -10430,14 +12162,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testClassifier @@ -10445,10 +12191,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ + + + testDoctitle @@ -10457,10 +12200,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -10469,10 +12210,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). + + + testOverview @@ -10481,10 +12219,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -10493,10 +12229,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. -+ ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -10504,14 +12238,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useDefaultManifestFile @@ -10519,9 +12255,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. -+ -+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ Set this to true to enable the use of the defaultManifestFile. + + + @@ -10530,7 +12264,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -10538,28 +12273,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -10574,7 +12312,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${maven.javadoc.classifier} + ${debug} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -10587,13 +12324,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} + ${project.build.finalName} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -10624,7 +12362,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ++ + + ${overview} + ${packagesheader} @@ -10667,7 +12405,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-javadoc -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. ++ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. ++See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html> + test + false + true @@ -10684,12 +12423,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -10697,7 +12444,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -10705,7 +12453,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -10713,15 +12462,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -10729,14 +12470,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -10744,7 +12486,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -10752,28 +12495,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -10781,31 +12533,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -10813,14 +12569,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -10828,7 +12577,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -10836,7 +12587,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -10844,35 +12597,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -10880,14 +12644,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -10895,42 +12664,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -10938,7 +12720,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -10946,35 +12728,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -10982,17 +12780,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -11000,7 +12798,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -11008,7 +12813,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -11016,7 +12824,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -11024,15 +12832,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -11040,7 +12852,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -11048,42 +12861,52 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + name @@ -11091,49 +12914,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -11141,21 +12973,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -11163,14 +13000,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -11178,29 +13019,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -11208,14 +13054,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -11223,14 +13072,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -11238,14 +13091,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -11253,21 +13100,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -11275,7 +13131,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -11283,14 +13139,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -11298,30 +13157,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -11330,14 +13191,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -11345,36 +13209,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -11382,7 +13254,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -11390,14 +13265,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -11405,14 +13284,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testDescription @@ -11421,7 +13314,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testDoctitle @@ -11430,7 +13323,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -11439,7 +13333,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). ++Could be used in addition of docfilessubdirs parameter. ++See docfilessubdirs. + + + testName @@ -11448,7 +13344,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testOverview @@ -11457,7 +13353,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -11466,7 +13363,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -11474,14 +13372,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -11489,7 +13389,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -11497,28 +13398,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -11532,7 +13436,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -11545,12 +13448,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -11581,13 +13485,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + ${quiet} + -+ ${reportTestOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + ${show} @@ -11625,7 +13528,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-javadoc-no-fork -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. Note that this goal does require generation of test sources before site generation, e.g. by invoking mvn clean deploy site. ++See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>, Javadoc Options <http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options> + test + false + true @@ -11641,12 +13545,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -11654,7 +13566,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -11662,7 +13575,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -11670,15 +13584,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -11686,14 +13592,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -11701,7 +13608,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -11709,28 +13617,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -11738,31 +13655,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -11770,14 +13691,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -11785,7 +13699,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -11793,7 +13709,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -11801,35 +13719,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -11837,14 +13766,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -11852,42 +13786,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -11895,7 +13842,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -11903,35 +13850,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -11939,17 +13902,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -11957,7 +13920,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -11965,7 +13935,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -11973,7 +13946,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -11981,15 +13954,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -11997,7 +13974,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -12005,42 +13983,52 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + name @@ -12048,49 +14036,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -12098,21 +14095,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -12120,14 +14122,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -12135,29 +14141,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -12165,14 +14176,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -12180,14 +14194,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -12195,14 +14213,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -12210,21 +14222,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -12232,7 +14253,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -12240,14 +14261,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -12255,30 +14279,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -12287,14 +14313,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -12302,36 +14331,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -12339,7 +14376,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -12347,14 +14387,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -12362,14 +14406,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testDescription @@ -12378,7 +14436,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testDoctitle @@ -12387,7 +14445,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -12396,7 +14455,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). ++Could be used in addition of docfilessubdirs parameter. ++See docfilessubdirs. + + + testName @@ -12405,7 +14466,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testOverview @@ -12414,7 +14475,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -12423,7 +14485,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -12431,14 +14494,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -12446,7 +14511,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -12454,28 +14520,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -12489,7 +14558,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -12502,12 +14570,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -12538,13 +14607,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + ${quiet} + -+ ${reportTestOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + ${show} @@ -12582,7 +14650,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-resource-bundle -+ Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from {@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself. ++ Bundle TestJavadocJarMojo.testJavadocDirectory, along with javadoc configuration options from such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself. + test + false + true @@ -12599,12 +14667,20 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + + ++ addStylesheets ++ java.lang.String[] ++ 3.3.0 ++ false ++ true ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> ++ ++ + additionalDependencies -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency> + 2.8.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -12612,7 +14688,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -12620,7 +14697,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -12628,15 +14706,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ addStylesheets -+ java.lang.String[] -+ 3.3.0 -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -12644,14 +14714,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -12659,7 +14730,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -12667,28 +14739,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -12696,31 +14777,35 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks -+ java.util.List ++ java.util.List<org.apache.maven.plugins.javadoc.DependencyLink> + 3.3.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -12728,7 +14813,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -12736,7 +14823,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -12744,35 +14833,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -12780,14 +14880,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -12795,42 +14900,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. -+ -+ -+ excludedocfilessubdir -+ java.lang.String -+ false -+ true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. ++ ++ ++ excludedocfilessubdir ++ java.lang.String ++ false ++ true ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -12838,7 +14956,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -12846,35 +14964,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -12882,17 +15016,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -12900,7 +15034,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -12908,7 +15049,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -12916,7 +15060,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + javadocVersion @@ -12924,15 +15068,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain -+ java.util.Map ++ java.util.Map<java.lang.String, java.lang.String> + 3.0.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -12940,7 +15088,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -12948,84 +15097,103 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + links -+ java.util.ArrayList ++ java.util.ArrayList<java.lang.String> + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + nocomment + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -13033,21 +15201,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -13055,14 +15228,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -13070,29 +15247,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -13100,14 +15282,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -13115,14 +15300,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + quiet + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + release @@ -13130,7 +15319,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + resourcesArtifacts @@ -13138,21 +15328,30 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + show + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -13160,7 +15359,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -13168,14 +15367,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -13183,30 +15385,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes -+ java.util.List ++ java.util.List<java.lang.String> + 2.9 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -13215,14 +15419,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -13230,36 +15437,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -13267,7 +15482,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -13275,14 +15493,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -13290,14 +15512,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -13305,7 +15541,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + java.io.File + false + true -+ Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from {@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). + + + top @@ -13313,14 +15549,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -13328,7 +15566,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -13336,28 +15575,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -13382,12 +15624,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${doclint} + ${doctitle} + ${encoding} -+ ${excludedocfilessubdir} + ${excludePackageNames} ++ ${excludedocfilessubdir} + ${extdirs} + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -13417,7 +15660,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} @@ -13455,13 +15698,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + -diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/plugin.xml maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/plugin.xml ---- maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/plugin.xml 1970-01-01 01:00:00.000000000 +0100 -+++ maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/plugin.xml 2023-09-20 08:59:15.926733566 +0200 -@@ -0,0 +1,19825 @@ +--- a/src/main/filtered-resources/META-INF/maven/plugin.xml 1970-01-01 01:00:00.000000000 +0100 ++++ b/src/main/filtered-resources/META-INF/maven/plugin.xml 2024-11-04 11:07:58.820245262 +0100 +@@ -0,0 +1,17337 @@ + + -+ ++ + + + ${project.name} @@ -13472,13 +15714,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + javadoc + false + true ++ 1.8 ++ 3.5.0 + + + aggregate -+ <p>Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.</p> ++ ++Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + -+<p>Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.</p> ++Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project. ++ + compile + false + true @@ -13500,10 +15745,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -13511,10 +15753,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -13522,10 +15761,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -13533,10 +15770,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -13544,10 +15779,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -13555,20 +15787,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -13576,10 +15803,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -13587,40 +15812,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -13628,10 +15850,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -13639,10 +15859,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -13650,10 +15868,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -13661,10 +15877,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -13672,19 +15886,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ 2.1 -+ false -+ true -+ Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -13692,10 +15894,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -13703,10 +15904,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -13714,50 +15914,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -13765,20 +15961,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -13786,60 +15981,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -13847,10 +16037,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -13858,50 +16045,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -13909,23 +16097,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -13933,10 +16115,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -13944,10 +16130,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -13955,10 +16141,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -13966,10 +16149,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -13977,10 +16157,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -13988,10 +16165,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -13999,10 +16177,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -14010,70 +16186,59 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + name @@ -14081,70 +16246,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -14152,30 +16305,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -14183,20 +16332,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -14204,41 +16351,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -14246,20 +16386,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -14267,40 +16404,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -14308,28 +16437,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ + + + resourcesArtifacts @@ -14337,30 +16453,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -14368,20 +16479,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -14389,10 +16499,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -14400,20 +16507,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -14421,10 +16525,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -14432,10 +16534,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -14443,20 +16542,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -14465,20 +16559,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -14486,51 +16577,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -14538,10 +16622,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -14549,20 +16633,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -14570,20 +16652,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -14591,20 +16681,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -14612,10 +16698,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -14623,40 +16707,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -14670,7 +16745,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -14689,6 +16763,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -14705,7 +16780,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${name} + ${nocomment} + ${nodeprecated} @@ -14721,16 +16796,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + -+ ${reportOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + @@ -14783,6 +16857,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -14790,11 +16868,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + aggregate-jar -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> ++ ++Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ + compile + false + true @@ -14804,7 +16882,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + package + compile -+ org.apache.maven.plugins.javadoc.AggregatorJavadocJar ++ org.apache.maven.plugins.javadoc.AggregatorJavadocJarMojo + java + per-lookup + once-per-session @@ -14817,10 +16895,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -14828,10 +16903,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -14839,10 +16911,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -14850,10 +16920,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -14861,10 +16929,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -14872,10 +16937,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + archive @@ -14883,32 +16945,23 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>. + + + attach + boolean + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies whether to attach the generated artifact to the project helper. ++ + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -14916,10 +16969,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -14927,40 +16978,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + classifier @@ -14968,11 +17016,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ + + + debug @@ -14980,10 +17024,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + defaultManifestFile @@ -14991,11 +17033,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + true + false -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true. + + + dependencyLinks @@ -15003,10 +17041,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -15014,10 +17050,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -15025,22 +17059,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.io.File -+ No reason given -+ false -+ true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -15048,10 +17068,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -15059,10 +17078,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -15070,50 +17088,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -15121,20 +17135,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -15142,60 +17155,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -15203,10 +17211,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -15214,61 +17219,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ 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. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -15276,34 +17278,24 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + jarOutputDirectory + java.lang.String + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the directory where the generated jar file will be put. + + + javaApiLinks @@ -15311,10 +17303,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -15322,10 +17318,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -15333,10 +17329,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -15344,10 +17337,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -15355,10 +17345,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -15366,10 +17353,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -15377,10 +17365,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -15388,130 +17374,110 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -15519,30 +17485,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -15550,20 +17512,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -15571,41 +17531,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -15613,20 +17566,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -15634,40 +17584,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -15675,20 +17617,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -15696,30 +17633,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -15727,20 +17659,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -15748,10 +17679,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -15759,20 +17687,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -15780,10 +17705,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -15791,10 +17714,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -15802,20 +17722,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -15824,20 +17739,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -15845,51 +17757,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -15897,10 +17802,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -15908,20 +17813,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -15929,20 +17832,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -15950,20 +17861,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useDefaultManifestFile @@ -15971,11 +17878,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Set this to true to enable the use of the defaultManifestFile. ++ + + + useStandardDocletOptions @@ -15983,10 +17887,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -15994,40 +17896,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -16043,7 +17936,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.classifier} + ${debug} + -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -16063,6 +17955,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnWarnings} + ${project.build.finalName} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -16080,7 +17973,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${nocomment} + ${nodeprecated} + ${nodeprecatedlist} @@ -16095,13 +17988,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + + ${resourcesArtifacts} @@ -16166,6 +18059,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -16173,8 +18070,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + aggregate-no-fork -+ Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + compile + false + true @@ -16195,10 +18091,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -16206,10 +18099,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -16217,10 +18107,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -16228,10 +18116,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -16239,10 +18125,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -16250,20 +18133,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -16271,10 +18149,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -16282,40 +18158,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -16323,10 +18196,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -16334,10 +18205,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -16345,10 +18214,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -16356,10 +18223,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -16367,19 +18232,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ 2.1 -+ false -+ true -+ Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -16387,10 +18240,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -16398,10 +18250,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -16409,50 +18260,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -16460,20 +18307,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -16481,60 +18327,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -16542,10 +18383,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -16553,50 +18391,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -16604,23 +18443,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -16628,10 +18461,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -16639,10 +18476,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -16650,10 +18487,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -16661,10 +18495,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -16672,10 +18503,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -16683,10 +18511,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -16694,10 +18523,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -16705,70 +18532,59 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + name @@ -16776,70 +18592,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -16847,30 +18651,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -16878,20 +18678,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -16899,41 +18697,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -16941,20 +18732,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -16962,40 +18750,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -17003,28 +18783,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ + + + resourcesArtifacts @@ -17032,30 +18799,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -17063,20 +18825,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -17084,10 +18845,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -17095,20 +18853,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -17116,10 +18871,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -17127,10 +18880,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -17138,20 +18888,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -17160,20 +18905,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -17181,51 +18923,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -17233,10 +18968,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -17244,20 +18979,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -17265,20 +18998,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -17286,20 +19027,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -17307,10 +19044,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -17318,40 +19053,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -17365,7 +19091,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -17384,6 +19109,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -17400,7 +19126,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${name} + ${nocomment} + ${nodeprecated} @@ -17416,16 +19142,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + -+ ${reportOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + @@ -17478,6 +19203,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -17485,7 +19214,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + fix -+ Fix Javadoc documentation and tags for the <code>Java code</code> for the project. ++ Fix Javadoc documentation and tags for the Java code for the project. ++See also: Where Tags Can Be Used <https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used> + compile + false + true @@ -17506,140 +19236,160 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Version to compare the current code against using the Clirr Maven Plugin <https://www.mojohaus.org/clirr-maven-plugin/>. ++See defaultSince. + + + defaultAuthor + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @author. + + + defaultSince + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @since. + + + defaultVersion + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @version. + + + encoding + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used. + + + excludes + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated excludes Java files, i.e. **/*Test.java. + + + fixClassComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the classes or interfaces Javadoc comments according the level. + + + fixFieldComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the fields Javadoc comments according the level. + + + fixMethodComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the methods Javadoc comments according the level. + + + fixTags + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are: ++* all (fix all Javadoc tags) ++* author (fix only @author tag) ++* version (fix only @version tag) ++* since (fix only @since tag) ++* param (fix only @param tag) ++* return (fix only @return tag) ++* throws (fix only @throws tag) ++* link (fix only @link tag) + + + force + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Forcing the goal execution i.e. skip warranty messages (not recommended). + + + ignoreClirr + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to ignore or not Clirr. + + + includes + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated includes Java files, i.e. **/*Test.java. ++ ++Note: default value is **\/*.java. + + + level + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: private, protected, public, package options for Javadoc <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + outputDirectory + java.io.File + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Output directory where Java classes will be rewritten. + + + project + org.apache.maven.project.MavenProject + true + false -+ Abstract class to fix Javadoc documentation and tags in source files. ++ The Maven Project Object. + + + removeUnknownThrows + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ ++Flag to remove throws tags from unknown classes. ++ ++NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness. ++ + + + session + org.apache.maven.execution.MavenSession + true + false -+ Abstract class to fix Javadoc documentation and tags in source files. ++ + + + settings + org.apache.maven.settings.Settings + true + false -+ Abstract class to fix Javadoc documentation and tags in source files. ++ The current user system settings for use in Maven. + + + + ${comparisonVersion} -+ ${defaultAuthor} ++ ${defaultAuthor} + ${defaultSince} -+ ${defaultVersion} ++ ${defaultVersion} + ${encoding} + ${excludes} + ${fixClassComment} @@ -17665,15 +19415,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + help -+ Display help information on maven-javadoc-plugin.<br> -+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details. ++ Display help information on maven-javadoc-plugin. ++Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. + false + false + false + false + false + true -+ org.apache.maven.plugins.javadoc.HelpMojo ++ org.apache.maven.plugins.maven_javadoc_plugin.HelpMojo + java + per-lookup + once-per-session @@ -17684,32 +19434,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + boolean + false + true -+ Display help information on maven-javadoc-plugin.<br> -+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details. ++ If true, display all settable properties for each goal. + + + goal + java.lang.String + false + true -+ Display help information on maven-javadoc-plugin.<br> -+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details. ++ The name of the goal for which to show help. If unspecified, all goals will be displayed. + + + indentSize + int + false + true -+ Display help information on maven-javadoc-plugin.<br> -+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details. ++ The number of spaces per indentation level, should be positive. + + + lineLength + int + false + true -+ Display help information on maven-javadoc-plugin.<br> -+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details. ++ The maximum length of a display line, should be positive. + + + @@ -17721,9 +19467,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + jar -+ Bundles the Javadoc documentation for <code>main Java code</code> in an <b>NON aggregator</b> project into -+a jar using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html"> -+Javadoc Tool</a>. ++ Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + compile + false + true @@ -17732,7 +19476,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + true + package -+ org.apache.maven.plugins.javadoc.JavadocJar ++ org.apache.maven.plugins.javadoc.JavadocJarMojo + java + per-lookup + once-per-session @@ -17745,10 +19489,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -17756,10 +19497,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -17767,10 +19505,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -17778,10 +19514,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -17789,10 +19523,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -17800,10 +19531,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + archive @@ -17811,32 +19539,23 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>. + + + attach + boolean + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies whether to attach the generated artifact to the project helper. ++ + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -17844,10 +19563,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -17855,40 +19572,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + classifier @@ -17896,11 +19610,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ + + + debug @@ -17908,10 +19618,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + defaultManifestFile @@ -17919,11 +19627,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + true + false -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true. + + + dependencyLinks @@ -17931,10 +19635,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -17942,10 +19644,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -17953,22 +19653,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.io.File -+ No reason given -+ false -+ true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -17976,10 +19662,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -17987,10 +19672,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -17998,50 +19682,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -18049,20 +19729,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -18070,60 +19749,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -18131,10 +19805,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -18142,61 +19813,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ 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. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -18204,34 +19872,24 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + jarOutputDirectory + java.lang.String + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the directory where the generated jar file will be put. + + + javaApiLinks @@ -18239,10 +19897,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -18250,10 +19912,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -18261,10 +19923,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -18272,10 +19931,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -18283,10 +19939,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -18294,10 +19947,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -18305,10 +19959,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -18316,130 +19968,110 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -18447,30 +20079,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -18478,20 +20106,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -18499,41 +20125,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -18541,20 +20160,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -18562,40 +20178,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -18603,20 +20211,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -18624,30 +20227,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -18655,20 +20253,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -18676,10 +20273,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -18687,20 +20281,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -18708,10 +20299,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -18719,10 +20308,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -18730,20 +20316,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -18752,20 +20333,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -18773,51 +20351,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -18825,10 +20396,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -18836,20 +20407,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -18857,20 +20426,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -18878,20 +20455,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useDefaultManifestFile @@ -18899,11 +20472,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Set this to true to enable the use of the defaultManifestFile. ++ + + + useStandardDocletOptions @@ -18911,10 +20481,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -18922,40 +20490,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -18971,7 +20530,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.classifier} + ${debug} + -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -18991,6 +20549,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnWarnings} + ${project.build.finalName} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -19008,7 +20567,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${nocomment} + ${nodeprecated} + ${nodeprecatedlist} @@ -19023,13 +20582,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + + ${resourcesArtifacts} @@ -19094,6 +20653,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -19101,8 +20664,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + javadoc -+ Generates documentation for the <code>Java code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ Generates documentation for the Java code in a NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. ++See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html> + compile + false + true @@ -19124,10 +20687,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -19135,10 +20695,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -19146,10 +20703,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -19157,10 +20712,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -19168,10 +20721,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -19179,20 +20729,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -19200,10 +20745,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -19211,40 +20754,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -19252,10 +20792,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -19263,10 +20801,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -19274,10 +20810,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -19285,10 +20819,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -19296,19 +20828,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ 2.1 -+ false -+ true -+ Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -19316,10 +20836,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -19327,10 +20846,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -19338,50 +20856,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -19389,20 +20903,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -19410,60 +20923,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -19471,10 +20979,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -19482,50 +20987,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -19533,23 +21039,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -19557,10 +21057,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -19568,10 +21072,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -19579,10 +21083,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -19590,10 +21091,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -19601,10 +21099,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -19612,10 +21107,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -19623,10 +21119,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -19634,70 +21128,59 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + name @@ -19705,70 +21188,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -19776,30 +21247,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -19807,20 +21274,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -19828,41 +21293,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -19870,20 +21328,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -19891,40 +21346,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -19932,28 +21379,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ + + + resourcesArtifacts @@ -19961,30 +21395,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -19992,20 +21421,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -20013,10 +21441,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -20024,20 +21449,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -20045,10 +21467,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -20056,10 +21476,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -20067,20 +21484,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -20089,20 +21501,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -20110,51 +21519,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -20162,10 +21564,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -20173,20 +21575,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -20194,20 +21594,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -20215,20 +21623,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -20236,10 +21640,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -20247,40 +21649,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -20294,7 +21687,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -20313,6 +21705,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -20329,7 +21722,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${name} + ${nocomment} + ${nodeprecated} @@ -20345,16 +21738,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + -+ ${reportOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + @@ -20407,6 +21799,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -20414,9 +21810,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + javadoc-no-fork -+ Generates documentation for the <code>Java code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of sources before site generation, e.g. by invoking {@code mvn clean deploy site}. ++ Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. Note that this goal does require generation of sources before site generation, e.g. by invoking mvn clean deploy site. ++See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>, Javadoc Options <http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options> + compile + false + true @@ -20437,10 +21832,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -20448,10 +21840,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -20459,10 +21848,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -20470,10 +21857,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -20481,10 +21866,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -20492,20 +21874,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -20513,10 +21890,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -20524,40 +21899,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -20565,10 +21937,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -20576,10 +21946,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -20587,10 +21955,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -20598,10 +21964,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -20609,19 +21973,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ 2.1 -+ false -+ true -+ Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -20629,10 +21981,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -20640,10 +21991,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -20651,50 +22001,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -20702,20 +22048,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -20723,60 +22068,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -20784,10 +22124,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -20795,50 +22132,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -20846,23 +22184,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -20870,10 +22202,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -20881,10 +22217,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -20892,10 +22228,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -20903,10 +22236,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -20914,10 +22244,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -20925,10 +22252,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -20936,10 +22264,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -20947,70 +22273,59 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + name @@ -21018,70 +22333,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -21089,30 +22392,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -21120,20 +22419,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -21141,41 +22438,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -21183,20 +22473,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -21204,40 +22491,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -21245,28 +22524,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the <code>Java code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ + + + resourcesArtifacts @@ -21274,30 +22540,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -21305,20 +22566,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -21326,10 +22586,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -21337,20 +22594,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -21358,10 +22612,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -21369,10 +22621,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -21380,20 +22629,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -21402,20 +22646,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -21423,51 +22664,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -21475,10 +22709,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -21486,20 +22720,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -21507,20 +22739,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -21528,20 +22768,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -21549,10 +22785,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -21560,40 +22794,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -21607,7 +22832,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -21626,6 +22850,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -21642,7 +22867,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${name} + ${nocomment} + ${nodeprecated} @@ -21658,16 +22883,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + -+ ${reportOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + @@ -21720,6 +22944,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -21727,10 +22955,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + resource-bundle -+ Bundle {@link AbstractJavadocMojo#javadocDirectory}, along with javadoc configuration options such -+as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed -+by the javadoc plugin mojos when used by the <code>includeDependencySources</code> option, to generate -+javadocs that are somewhat consistent with those generated in the original project itself. ++ Bundle javadocDirectory, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself. + compile + false + true @@ -21752,10 +22977,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -21763,10 +22985,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -21774,10 +22993,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -21785,10 +23002,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -21796,10 +23011,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -21807,20 +23019,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -21828,10 +23035,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -21839,40 +23044,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -21880,10 +23082,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -21891,10 +23091,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -21902,10 +23100,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -21913,10 +23109,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -21924,10 +23118,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -21935,10 +23128,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -21946,50 +23138,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -21997,20 +23185,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -22018,60 +23205,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -22079,10 +23261,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -22090,61 +23269,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + false -+ Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from -+{@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable -+artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the -+<code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent -+with those generated in the original project itself. ++ Base name of artifacts produced by this project. This will be combined with getAttachmentClassifier() to produce the name for this bundle jar. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -22152,23 +23328,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -22176,10 +23346,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -22187,10 +23361,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -22198,10 +23372,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -22209,10 +23380,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -22220,10 +23388,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -22231,10 +23396,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -22242,10 +23408,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -22253,130 +23417,110 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -22384,30 +23528,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -22415,20 +23555,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -22436,41 +23574,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -22478,20 +23609,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -22499,40 +23627,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -22540,20 +23660,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -22561,30 +23676,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -22592,20 +23702,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -22613,10 +23722,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -22624,20 +23730,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -22645,10 +23748,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -22656,10 +23757,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -22667,20 +23765,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -22689,20 +23782,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -22710,51 +23800,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -22762,10 +23845,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -22773,20 +23856,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -22794,20 +23875,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -22815,20 +23904,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -22836,10 +23921,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -22847,40 +23930,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -22912,6 +23986,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnWarnings} + +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -22928,7 +24003,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${nocomment} + ${nodeprecated} + ${nodeprecatedlist} @@ -22943,13 +24018,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + + ${resourcesArtifacts} @@ -23008,6 +24083,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -23015,10 +24094,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-aggregate -+ <p>Generates documentation for the <code>Java Test code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.</p> ++ ++Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + -+<p>Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.</p> ++Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project. ++ + test + false + true @@ -23040,10 +24120,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -23051,10 +24128,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -23062,10 +24136,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -23073,10 +24145,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -23084,10 +24154,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -23095,20 +24162,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -23116,10 +24178,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -23127,40 +24187,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -23168,10 +24225,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -23179,10 +24234,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -23190,10 +24243,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -23201,10 +24252,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -23212,20 +24261,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ false -+ true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -23233,10 +24269,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -23244,10 +24279,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -23255,50 +24289,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -23306,20 +24336,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -23327,60 +24356,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -23388,10 +24412,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -23399,50 +24420,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -23450,23 +24472,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -23474,10 +24490,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -23485,10 +24505,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -23496,10 +24516,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -23507,10 +24524,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -23518,10 +24532,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -23529,10 +24540,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -23540,10 +24552,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -23551,70 +24561,59 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + name @@ -23622,70 +24621,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -23693,30 +24680,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -23724,20 +24707,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -23745,41 +24726,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -23787,20 +24761,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -23808,40 +24779,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -23849,30 +24812,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -23880,30 +24828,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -23911,20 +24854,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -23932,10 +24874,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -23943,20 +24882,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -23964,10 +24900,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -23975,10 +24909,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -23986,20 +24917,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -24008,20 +24934,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -24029,51 +24952,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -24081,10 +24997,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -24092,20 +25008,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -24113,20 +25027,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testDescription @@ -24135,10 +25057,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testDoctitle @@ -24147,10 +25066,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -24159,10 +25076,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). ++Could be used in addition of docfilessubdirs parameter. ++See docfilessubdirs. + + + testName @@ -24171,10 +25087,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testOverview @@ -24183,10 +25096,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -24195,10 +25106,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -24206,20 +25115,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -24227,10 +25132,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -24238,40 +25141,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -24285,7 +25179,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -24304,6 +25197,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -24320,7 +25214,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${name} + ${nocomment} + ${nodeprecated} @@ -24336,16 +25230,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + -+ ${reportTestOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + @@ -24404,6 +25297,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -24411,11 +25308,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-aggregate-jar -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> ++ ++Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. ++ + test + false + true @@ -24425,7 +25322,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + true + package + test-compile -+ org.apache.maven.plugins.javadoc.AggregatorTestJavadocJar ++ org.apache.maven.plugins.javadoc.AggregatorTestJavadocJarMojo + java + per-lookup + once-per-session @@ -24438,10 +25335,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -24449,10 +25343,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -24460,10 +25351,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -24471,10 +25360,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -24482,10 +25369,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -24493,10 +25377,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + archive @@ -24504,32 +25385,23 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>. + + + attach + boolean + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies whether to attach the generated artifact to the project helper. ++ + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -24537,10 +25409,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -24548,40 +25418,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + classifier @@ -24589,11 +25456,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ + + + debug @@ -24601,10 +25464,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + defaultManifestFile @@ -24612,11 +25473,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + true + false -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true. + + + dependencyLinks @@ -24624,10 +25481,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -24635,10 +25490,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -24646,22 +25499,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.io.File -+ No reason given -+ false -+ true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -24669,10 +25508,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -24680,10 +25518,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -24691,50 +25528,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -24742,20 +25575,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -24763,60 +25595,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -24824,10 +25651,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -24835,61 +25659,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ 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. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -24897,34 +25718,24 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + jarOutputDirectory + java.lang.String + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the directory where the generated jar file will be put. + + + javaApiLinks @@ -24932,10 +25743,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -24943,10 +25758,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -24954,10 +25769,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -24965,10 +25777,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -24976,10 +25785,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -24987,10 +25793,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -24998,10 +25805,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -25009,130 +25814,110 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -25140,30 +25925,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -25171,20 +25952,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -25192,41 +25971,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory + java.io.File + true + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -25234,20 +26006,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -25255,40 +26024,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -25296,20 +26057,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -25317,30 +26073,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -25348,20 +26099,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -25369,10 +26119,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -25380,20 +26127,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -25401,10 +26145,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -25412,10 +26154,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -25423,20 +26162,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -25445,20 +26179,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -25466,51 +26197,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -25518,10 +26242,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -25529,20 +26253,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -25550,20 +26272,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testClassifier @@ -25571,11 +26301,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ + + + testDoctitle @@ -25584,11 +26310,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -25597,11 +26320,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). + + + testOverview @@ -25610,11 +26329,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -25623,11 +26339,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -25635,20 +26348,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useDefaultManifestFile @@ -25656,11 +26365,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Set this to true to enable the use of the defaultManifestFile. ++ + + + useStandardDocletOptions @@ -25668,10 +26374,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -25679,40 +26383,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -25728,7 +26423,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.classifier} + ${debug} + -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -25748,6 +26442,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnWarnings} + ${project.build.finalName} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -25765,7 +26460,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${nocomment} + ${nodeprecated} + ${nodeprecatedlist} @@ -25780,13 +26475,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + + ${resourcesArtifacts} @@ -25856,6 +26551,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -25863,8 +26562,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-aggregate-no-fork -+ Generates documentation for the <code>Java Test code</code> in an <b>aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + test + false + true @@ -25885,10 +26583,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -25896,10 +26591,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -25907,10 +26599,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -25918,10 +26608,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -25929,10 +26617,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -25940,20 +26625,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -25961,10 +26641,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -25972,40 +26650,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -26013,10 +26688,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -26024,10 +26697,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -26035,10 +26706,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -26046,10 +26715,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -26057,20 +26724,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ false -+ true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -26078,10 +26732,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -26089,10 +26742,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -26100,50 +26752,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -26151,20 +26799,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -26172,60 +26819,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -26233,10 +26875,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -26244,50 +26883,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -26295,23 +26935,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -26319,10 +26953,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -26330,10 +26968,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -26341,10 +26979,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -26352,10 +26987,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -26363,10 +26995,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -26374,10 +27003,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -26385,10 +27015,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -26396,70 +27024,59 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + name @@ -26467,70 +27084,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -26538,30 +27143,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -26569,20 +27170,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -26590,41 +27189,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -26632,20 +27224,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -26653,40 +27242,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -26694,30 +27275,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -26725,30 +27291,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -26756,20 +27317,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -26777,10 +27337,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -26788,20 +27345,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -26809,10 +27363,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -26820,10 +27372,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -26831,20 +27380,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -26853,20 +27397,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -26874,51 +27415,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -26926,10 +27460,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -26937,20 +27471,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -26958,20 +27490,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testDescription @@ -26980,10 +27520,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testDoctitle @@ -26992,10 +27529,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -27004,10 +27539,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). ++Could be used in addition of docfilessubdirs parameter. ++See docfilessubdirs. + + + testName @@ -27016,10 +27550,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testOverview @@ -27028,10 +27559,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -27040,10 +27569,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -27051,20 +27578,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -27072,10 +27595,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -27083,40 +27604,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -27130,7 +27642,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -27149,6 +27660,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -27165,7 +27677,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${name} + ${nocomment} + ${nodeprecated} @@ -27181,16 +27693,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + -+ ${reportTestOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + @@ -27249,6 +27760,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -27256,7 +27771,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-fix -+ Fix Javadoc documentation and tags for the <code>Test Java code</code> for the project. ++ Fix Javadoc documentation and tags for the Test Java code for the project. ++See also: Where Tags Can Be Used <https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used> + test + false + true @@ -27277,140 +27793,160 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Version to compare the current code against using the Clirr Maven Plugin <https://www.mojohaus.org/clirr-maven-plugin/>. ++See defaultSince. + + + defaultAuthor + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @author. + + + defaultSince + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @since. + + + defaultVersion + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Default value for the Javadoc tag @version. + + + encoding + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used. + + + excludes + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated excludes Java files, i.e. **/*Test.java. + + + fixClassComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the classes or interfaces Javadoc comments according the level. + + + fixFieldComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the fields Javadoc comments according the level. + + + fixMethodComment + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to fix the methods Javadoc comments according the level. + + + fixTags + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are: ++* all (fix all Javadoc tags) ++* author (fix only @author tag) ++* version (fix only @version tag) ++* since (fix only @since tag) ++* param (fix only @param tag) ++* return (fix only @return tag) ++* throws (fix only @throws tag) ++* link (fix only @link tag) + + + force + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Forcing the goal execution i.e. skip warranty messages (not recommended). + + + ignoreClirr + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Flag to ignore or not Clirr. + + + includes + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Comma separated includes Java files, i.e. **/*Test.java. ++ ++Note: default value is **\/*.java. + + + level + java.lang.String + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: private, protected, public, package options for Javadoc <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + outputDirectory + java.io.File + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ Output directory where Java classes will be rewritten. + + + project + org.apache.maven.project.MavenProject + true + false -+ Abstract class to fix Javadoc documentation and tags in source files. ++ The Maven Project Object. + + + removeUnknownThrows + boolean + false + true -+ Abstract class to fix Javadoc documentation and tags in source files. ++ ++Flag to remove throws tags from unknown classes. ++ ++NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness. ++ + + + session + org.apache.maven.execution.MavenSession + true + false -+ Abstract class to fix Javadoc documentation and tags in source files. ++ + + + settings + org.apache.maven.settings.Settings + true + false -+ Abstract class to fix Javadoc documentation and tags in source files. ++ The current user system settings for use in Maven. + + + + ${comparisonVersion} -+ ${defaultAuthor} ++ ${defaultAuthor} + ${defaultSince} -+ ${defaultVersion} ++ ${defaultVersion} + ${encoding} + ${excludes} + ${fixClassComment} @@ -27436,9 +27972,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-jar -+ Bundles the Javadoc documentation for <code>test Java code</code> in an <b>NON aggregator</b> project into -+a jar using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html"> -+Javadoc Tool</a>. ++ Bundles the Javadoc documentation for test Java code in an NON aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. + test + false + true @@ -27447,7 +27981,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + false + true + package -+ org.apache.maven.plugins.javadoc.TestJavadocJar ++ org.apache.maven.plugins.javadoc.TestJavadocJarMojo + java + per-lookup + once-per-session @@ -27460,10 +27994,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -27471,10 +28002,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -27482,10 +28010,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -27493,10 +28019,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -27504,10 +28028,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -27515,10 +28036,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + archive @@ -27526,32 +28044,23 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>. + + + attach + boolean + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies whether to attach the generated artifact to the project helper. ++ + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -27559,10 +28068,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -27570,40 +28077,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + classifier @@ -27611,11 +28115,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ + + + debug @@ -27623,10 +28123,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + defaultManifestFile @@ -27634,11 +28132,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + true + false -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true. + + + dependencyLinks @@ -27646,10 +28140,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -27657,10 +28149,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -27668,22 +28158,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.io.File -+ No reason given -+ false -+ true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -27691,10 +28167,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -27702,10 +28177,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -27713,50 +28187,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -27764,20 +28234,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -27785,60 +28254,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -27846,10 +28310,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -27857,61 +28318,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ 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. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -27919,34 +28377,24 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + jarOutputDirectory + java.lang.String + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the directory where the generated jar file will be put. + + + javaApiLinks @@ -27954,10 +28402,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -27965,10 +28417,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -27976,10 +28428,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -27987,10 +28436,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -27998,10 +28444,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -28009,10 +28452,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -28020,10 +28464,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -28031,130 +28473,110 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -28162,30 +28584,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -28193,20 +28611,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -28214,41 +28630,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory + java.io.File + true + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -28256,20 +28665,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -28277,40 +28683,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -28318,20 +28716,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -28339,30 +28732,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -28370,20 +28758,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -28391,10 +28778,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -28402,20 +28786,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -28423,10 +28804,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -28434,10 +28813,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -28445,20 +28821,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -28467,20 +28838,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -28488,51 +28856,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -28540,10 +28901,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -28551,20 +28912,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -28572,20 +28931,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testClassifier @@ -28593,11 +28960,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.10 + true + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ + + + testDoctitle @@ -28606,11 +28969,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -28619,11 +28979,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). + + + testOverview @@ -28632,11 +28988,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -28645,11 +28998,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -28657,20 +29007,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useDefaultManifestFile @@ -28678,11 +29024,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar -+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. -+</p> -+ -+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> ++ Set this to true to enable the use of the defaultManifestFile. ++ + + + useStandardDocletOptions @@ -28690,10 +29033,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -28701,40 +29042,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -28750,7 +29082,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.classifier} + ${debug} + -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -28770,6 +29101,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnWarnings} + ${project.build.finalName} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -28787,7 +29119,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${nocomment} + ${nodeprecated} + ${nodeprecatedlist} @@ -28802,13 +29134,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + + ${resourcesArtifacts} @@ -28878,6 +29210,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -28885,8 +29221,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-javadoc -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. ++ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. ++See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html> + test + false + true @@ -28908,10 +29244,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -28919,10 +29252,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -28930,10 +29260,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -28941,10 +29269,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -28952,10 +29278,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -28963,20 +29286,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -28984,10 +29302,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -28995,40 +29311,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -29036,10 +29349,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -29047,10 +29358,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -29058,10 +29367,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -29069,10 +29376,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -29080,20 +29385,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ false -+ true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -29101,10 +29393,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -29112,10 +29403,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -29123,50 +29413,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -29174,20 +29460,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -29195,60 +29480,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -29256,10 +29536,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -29267,50 +29544,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -29318,23 +29596,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -29342,10 +29614,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -29353,10 +29629,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -29364,10 +29640,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -29375,10 +29648,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -29386,10 +29656,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -29397,10 +29664,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -29408,10 +29676,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -29419,70 +29685,59 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + name @@ -29490,70 +29745,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -29561,30 +29804,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -29592,20 +29831,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -29613,41 +29850,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -29655,20 +29885,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -29676,40 +29903,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -29717,30 +29936,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -29748,30 +29952,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -29779,20 +29978,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -29800,10 +29998,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -29811,20 +30006,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -29832,10 +30024,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -29843,10 +30033,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -29854,20 +30041,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -29876,20 +30058,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -29897,51 +30076,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -29949,10 +30121,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -29960,20 +30132,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -29981,20 +30151,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testDescription @@ -30003,10 +30181,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testDoctitle @@ -30015,10 +30190,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -30027,10 +30200,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). ++Could be used in addition of docfilessubdirs parameter. ++See docfilessubdirs. + + + testName @@ -30039,10 +30211,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testOverview @@ -30051,10 +30220,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -30063,10 +30230,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -30074,20 +30239,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -30095,10 +30256,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -30106,40 +30265,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -30153,7 +30303,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -30172,6 +30321,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -30188,7 +30338,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${name} + ${nocomment} + ${nodeprecated} @@ -30204,16 +30354,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + -+ ${reportTestOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + @@ -30272,6 +30421,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -30279,10 +30432,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-javadoc-no-fork -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. Note that this goal does require generation of test sources before site generation, e.g. by invoking mvn clean deploy site. ++See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>, Javadoc Options <http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options> + test + false + true @@ -30303,10 +30454,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -30314,10 +30462,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -30325,10 +30470,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -30336,10 +30479,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -30347,10 +30488,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -30358,20 +30496,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -30379,10 +30512,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -30390,40 +30521,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -30431,10 +30559,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -30442,10 +30568,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -30453,10 +30577,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -30464,10 +30586,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + description @@ -30475,20 +30595,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ destDir -+ java.lang.String -+ false -+ true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + detectJavaApiLink @@ -30496,10 +30603,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -30507,10 +30613,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -30518,50 +30623,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -30569,20 +30670,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -30590,60 +30690,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -30651,10 +30746,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -30662,50 +30754,51 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -30713,23 +30806,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -30737,10 +30824,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -30748,10 +30839,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -30759,10 +30850,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -30770,10 +30858,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -30781,10 +30866,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -30792,10 +30874,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -30803,10 +30886,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -30814,70 +30895,59 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + name @@ -30885,70 +30955,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -30956,30 +31014,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -30987,20 +31041,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -31008,41 +31060,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -31050,20 +31095,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -31071,40 +31113,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -31112,30 +31146,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. -+ -+ -+ reportOutputDirectory -+ java.io.File -+ true -+ true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -31143,30 +31162,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -31174,20 +31188,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -31195,10 +31208,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -31206,20 +31216,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -31227,10 +31234,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -31238,10 +31243,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -31249,20 +31251,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -31271,20 +31268,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -31292,51 +31286,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -31344,10 +31331,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -31355,20 +31342,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -31376,20 +31361,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testDescription @@ -31398,10 +31391,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testDoctitle @@ -31410,10 +31400,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -31422,10 +31410,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). ++Could be used in addition of docfilessubdirs parameter. ++See docfilessubdirs. + + + testName @@ -31434,10 +31421,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). + + + testOverview @@ -31446,10 +31430,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testWindowtitle @@ -31458,10 +31440,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Test title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + top @@ -31469,20 +31449,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -31490,10 +31466,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -31501,40 +31475,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -31548,7 +31513,6 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${charset} + ${debug} + ${description} -+ ${destDir} + ${detectJavaApiLink} + ${detectLinks} + ${detectOfflineLinks} @@ -31567,6 +31531,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnError} + ${maven.javadoc.failOnWarnings} +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -31583,7 +31548,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${name} + ${nocomment} + ${nodeprecated} @@ -31599,16 +31564,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + -+ ${reportTestOutputDirectory} + ${resourcesArtifacts} + ${serialwarn} + @@ -31667,6 +31631,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -31674,11 +31642,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + test-resource-bundle -+ Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from -+{@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable -+artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the -+<code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent -+with those generated in the original project itself. ++ Bundle TestJavadocJarMojo.testJavadocDirectory, along with javadoc configuration options from such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself. + test + false + true @@ -31700,10 +31664,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> + + + additionalDependencies @@ -31711,10 +31672,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> + + + additionalJOption @@ -31722,10 +31680,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption> ++See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html> + + + additionalJOptions @@ -31733,10 +31689,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + additionalOptions @@ -31744,10 +31698,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + applyJavadocSecurityFix @@ -31755,20 +31706,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ To apply a security fix on generated javadoc, see + + + author + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether or not the author text is included in the generated Javadocs. ++See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + bootclasspath @@ -31776,10 +31722,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>. + + + bootclasspathArtifacts @@ -31787,40 +31731,37 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifacts where the boot classes reside. ++Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> ++See Javadoc. ++See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path> + + + bottom + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + breakiterator + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Uses the sentence break iterator to determine the end of the first sentence. ++See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + charset + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + debug @@ -31828,10 +31769,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. ++ + + + dependencyLinks @@ -31839,10 +31778,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.3.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks> ++See also: detectLinks + + + dependencySourceExcludes @@ -31850,10 +31787,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of excluded dependency-source patterns. Example: org.apache.maven.shared:* ++See also: includeDependencySources + + + dependencySourceIncludes @@ -31861,10 +31796,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ List of included dependency-source patterns. Example: org.apache.maven:* ++See also: includeDependencySources + + + detectJavaApiLink @@ -31872,10 +31805,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 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 + + + detectLinks @@ -31883,10 +31815,9 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs. ++See also: links, dependencyLinks + + + detectOfflineLinks @@ -31894,50 +31825,46 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + docencoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8. ++See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + docfilessubdirs + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables deep copying of the **/doc-files directories and the specifc 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory + + + doclet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the doclet used in generating the documentation. ++See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifact + org.apache.maven.plugins.javadoc.options.DocletArtifact + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the artifact containing the doclet starting class file (specified with the doclet option). ++Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletArtifacts @@ -31945,20 +31872,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option). ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> ++See Javadoc. ++ ++See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + docletPath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + doclint @@ -31966,60 +31892,55 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies specific checks to be performed on Javadoc comments. ++See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>. + + + doctitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed near the top of the overview summary file. ++See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + encoding + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>. + + + excludePackageNames + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: ++ ++* a wildcard at the beginning should match one or more directories ++* any other wildcard must match exactly one directory ++ ++Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> ++See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + excludedocfilessubdir + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:). ++See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs + + + extdirs + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;). ++See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>. + + + failOnError @@ -32027,10 +31948,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are errors during javadoc execution or not. + + + failOnWarnings @@ -32038,61 +31956,58 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies if the build will fail if there are warning during javadoc execution or not. + + + finalName + java.lang.String + false + false -+ Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from -+{@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable -+artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the -+<code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent -+with those generated in the original project itself. ++ Base name of artifacts produced by this project. This will be combined with getAttachmentClassifier() to produce the name for this bundle jar. + + + footer + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the footer text to be placed at the bottom of each output file. ++See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ ++ ++ forceRootLocale ++ boolean ++ 3.8.0 ++ false ++ true ++ 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. + + + groups + org.apache.maven.plugins.javadoc.options.Group[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it. ++See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group + + + header + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the header text to be placed at the top of each output file. ++See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + helpfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <nohelp/>. ++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: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + includeDependencySources @@ -32100,23 +32015,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + includeTransitiveDependencySources + boolean + 2.7 -+ if these sources depend on transitive dependencies, those dependencies should be added to the pom as -+ direct dependencies ++ if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run. ++See also: includeDependencySources + + + javaApiLinks @@ -32124,10 +32033,14 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.6 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Use this parameter only if 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/ ++ + + + javadocDirectory @@ -32135,10 +32048,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 + + + javadocExecutable @@ -32146,10 +32059,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + javadocOptionsDir @@ -32157,10 +32067,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles. + + + javadocVersion @@ -32168,10 +32075,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". + + + jdkToolchain @@ -32179,10 +32083,11 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.0.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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 <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1 + + + keywords @@ -32190,10 +32095,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Adds HTML meta keyword tags to the generated file for each class. ++See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + legacyMode @@ -32201,130 +32104,110 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + links + java.util.ArrayList + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Creates links to existing javadoc-generated documentation of external referenced classes. ++Notes: ++ ++* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line. ++* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists. ++* If detectLinks is defined, the links between the project dependencies are automatically added. ++* 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + linksource + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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>. ++<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + locale + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the locale that javadoc uses when generating documentation. ++See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + maxmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + minmemory + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + -+ mojo ++ mojoExecution + org.apache.maven.plugin.MojoExecution -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + nocomment + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Suppress the entire comment body, including the main description and all tags, generating only declarations. ++See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nodeprecated + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Prevents the generation of any deprecated API at all in the documentation. ++See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + nodeprecatedlist + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nohelp + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + noindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the index from the generated docs. ++Note: could be in conflict with splitindex ++See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nonavbar + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the navigation bar from the generated docs. ++See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nooverview @@ -32332,30 +32215,26 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the entire overview page from the generated docs. ++Note: could be in conflict with overview. ++Standard Doclet undocumented option. ++ + + + noqualifier + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier> ++See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + nosince + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits from the generated docs the "Since" sections associated with the since tags. ++See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notimestamp @@ -32363,20 +32242,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + notree + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Omits the class/interface hierarchy pages from the generated docs. ++See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + offline @@ -32384,41 +32261,34 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.6.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + offlineLinks + org.apache.maven.plugins.javadoc.options.OfflineLink[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes. ++Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> ++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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + old + boolean ++ No reason given + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>. + + + outputDirectory -+ destDir + java.io.File + true + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead. ++See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet> + + + outputTimestamp @@ -32426,20 +32296,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://reproducible-builds.org/docs/source-date-epoch/>). + + + overview + java.io.File + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. ++ + + + packagesheader @@ -32447,40 +32314,32 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specify the text for upper left frame. ++See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521> + + + project + org.apache.maven.project.MavenProject + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Project Object + + + quiet + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>). ++Since Java 5.0. ++See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + reactorProjects + java.util.List -+ false ++ true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The projects in the reactor for aggregation report. + + + release @@ -32488,20 +32347,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + JDK 9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release ++See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>. + + + repoSession + org.eclipse.aether.RepositorySystemSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ + + + resourcesArtifacts @@ -32509,30 +32363,25 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). ++Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> ++See Javadoc. ++ + + + serialwarn + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Generates compile-time warnings for missing serial tags. ++See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + session + org.apache.maven.execution.MavenSession + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The current build session instance. This is used for toolchain manager API calls. + + + settings @@ -32540,20 +32389,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.3 + true + false -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ The Maven Settings. + + + show + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the access level for classes and members to show in the Javadocs. Possible values are: ++* public (shows only public classes and members) ++* protected (shows only public and protected classes and members) ++* package (shows all classes and members not marked private) ++* private (shows all classes and members) ++See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc> + + + skip @@ -32561,10 +32409,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies whether the Javadoc generation should be skipped. + + + skippedModules @@ -32572,20 +32417,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++Comma separated list of modules (artifactId) to not add in aggregated javadoc ++ + + + source + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provide source compatibility with specified release. Since JDK 9 rather use release. ++See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>. + + + sourceDependencyCacheDir @@ -32593,10 +32435,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.7 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Directory where unpacked project sources / test-sources should be cached. ++See also: includeDependencySources + + + sourceFileExcludes @@ -32604,10 +32444,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes. + + + sourceFileIncludes @@ -32615,20 +32452,15 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.9 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes. + + + sourcepath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>. + + + sourcetab @@ -32637,20 +32469,17 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + splitindex + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + staleDataPath @@ -32658,51 +32487,44 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 3.2.0 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ ++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. ++ + + + stylesheet + java.lang.String -+ This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS. ++ This is no longer evaluated, instead use addStylesheets to customize the CSS. + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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. + + + stylesheetfile + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency. ++See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + subpackages + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:). ++See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + taglet + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the class file that starts the taglet used in generating the documentation for that tag. ++See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifact @@ -32710,10 +32532,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the Taglet artifact containing the taglet class files (.class). ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ++See Javadoc. ++See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + tagletArtifacts @@ -32721,20 +32543,18 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them. ++Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> ++See Javadoc. ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tagletpath + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ 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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + taglets @@ -32742,20 +32562,28 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.1 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret multiple taglets. ++Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> ++See Javadoc. ++ ++See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> + + + tags + org.apache.maven.plugins.javadoc.options.Tag[] + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. ++Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters: ++* X (disable tag) ++* a (all) ++* o (overview) ++* p (packages) ++* t (types, that is classes and interfaces) ++* c (constructors) ++* m (methods) ++* f (fields) See Javadoc. ++See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + testJavadocDirectory @@ -32763,11 +32591,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + java.io.File + false + true -+ Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from -+{@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable -+artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the -+<code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent -+with those generated in the original project itself. ++ Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). + + + top @@ -32775,20 +32599,16 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.4 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the top text to be placed at the top of each output file. ++See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + use + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes one "Use" page for each documented class and package. ++See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + useStandardDocletOptions @@ -32796,10 +32616,8 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.5 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet. ++Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> + + + validateLinks @@ -32807,40 +32625,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 2.8 + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated. + + + verbose + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Provides more detailed messages while javadoc is running. ++See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>. + + + version + boolean + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Includes the given version text in the generated docs. ++See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + windowtitle + java.lang.String + false + true -+ Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard -+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this -+goal does require generation of test sources before site generation, e.g. by invoking -+{@code mvn clean deploy site}. ++ Specifies the title to be placed in the HTML title tag. ++See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>. + + + @@ -32872,6 +32681,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.failOnWarnings} + +
${footer}
++ ${forceRootLocale} +
${header}
+ ${helpfile} + @@ -32888,7 +32698,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${locale} + ${maxmemory} + ${minmemory} -+ ++ + ${nocomment} + ${nodeprecated} + ${nodeprecatedlist} @@ -32903,13 +32713,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + ${maven.javadoc.offline} + ${offlineLinks} + ${old} -+ ${destDir} ++ + + ${overview} + ${packagesheader} + + ${quiet} -+ ${reactorProjects} ++ + + + ${resourcesArtifacts} @@ -32969,6 +32779,10 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + resourceResolver + + ++ org.apache.maven.doxia.tools.SiteTool ++ siteTool ++ ++ + org.apache.maven.toolchain.ToolchainManager + toolchainManager + @@ -32977,6 +32791,12 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + + + ++ org.eclipse.sisu ++ org.eclipse.sisu.plexus ++ jar ++ 0.9.0.M3 ++ ++ + org.slf4j + slf4j-api + jar @@ -32986,7 +32806,7 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + org.codehaus.plexus + plexus-classworlds + jar -+ 2.7.0 ++ 2.8.0 + + + org.codehaus.plexus @@ -32998,31 +32818,19 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + org.eclipse.sisu + org.eclipse.sisu.inject + jar -+ 0.9.0.M2 -+ -+ -+ javax.enterprise -+ cdi-api -+ jar -+ 1.1 -+ -+ -+ org.jboss.spec.javax.interceptor -+ jboss-interceptors-api_1.2_spec -+ jar -+ any -+ -+ -+ jakarta.inject -+ jakarta.inject-api -+ jar -+ 1.0 ++ 0.9.0.M3 + + + org.codehaus.plexus + plexus-interpolation + jar -+ 1.26 ++ 1.27 ++ ++ ++ org.apache.maven.resolver ++ maven-resolver-util ++ jar ++ 1.4.1 + + + javax.inject @@ -33034,19 +32842,31 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + org.apache.maven.reporting + maven-reporting-api + jar -+ 3.1.1 ++ 4.0.0 ++ ++ ++ org.apache.maven.doxia ++ doxia-core ++ jar ++ 2.0.0 ++ ++ ++ org.apache.maven.doxia ++ doxia-site-model ++ jar ++ 2.0.0 + + + org.apache.maven + maven-archiver + jar -+ 3.6.0 ++ 3.6.2 + + + org.apache.maven.shared + maven-invoker + jar -+ 3.2.0 ++ 3.3.0 + + + org.apache.maven.shared @@ -33058,97 +32878,49 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + org.apache.maven.shared + maven-common-artifact-filters + jar -+ 3.2.0 ++ 3.4.0 + + + org.apache.maven.doxia + doxia-sink-api + jar -+ 1.11.1 -+ -+ -+ org.apache.maven.doxia -+ doxia-logging-api -+ jar -+ 1.9.1 ++ 2.0.0 + + + org.apache.maven.doxia + doxia-site-renderer + jar -+ 1.11.1 ++ 2.0.0 + + + org.apache.maven.doxia + doxia-skin-model + jar -+ 1.9.2 ++ 2.0.0 + + -+ org.apache.maven.doxia -+ doxia-module-xhtml ++ org.apache.velocity ++ velocity-engine-core + jar -+ 1.9.1 ++ 2.4 + + + org.codehaus.plexus + plexus-velocity + jar -+ 1.2 ++ 2.2.0 + + + org.apache.maven.doxia -+ doxia-decoration-model ++ doxia-module-xhtml5 + jar -+ 1.9.2 -+ -+ -+ org.codehaus.plexus -+ plexus-container-default -+ jar -+ 1.0-alpha-30 -+ -+ -+ org.ow2.asm -+ asm-commons -+ jar -+ 5.0.3 -+ -+ -+ org.ow2.asm -+ asm-tree -+ jar -+ 9.5 -+ -+ -+ org.apache.xbean -+ xbean-reflect -+ jar -+ SYSTEM -+ -+ -+ junit -+ junit -+ jar -+ SYSTEM -+ -+ -+ org.hamcrest -+ hamcrest-core -+ jar -+ 1.3 -+ -+ -+ commons-collections -+ commons-collections -+ jar -+ 3.2.2 ++ 2.0.0 + + + org.apache.maven.doxia -+ doxia-core ++ doxia-integration-tools + jar -+ 1.9.1 ++ 2.0.0 + + + org.codehaus.plexus @@ -33157,40 +32929,22 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + 1.0-beta-10 + + -+ org.apache.maven.doxia -+ doxia-module-xhtml5 -+ jar -+ 1.9.1 -+ -+ -+ org.apache.velocity -+ velocity -+ jar -+ 1.7 -+ -+ -+ commons-lang -+ commons-lang -+ jar -+ 2.4 -+ -+ + org.apache.maven.wagon + wagon-provider-api + jar -+ 2.4 ++ 3.5.3 + + + org.apache.commons + commons-lang3 + jar -+ 3.12.0 ++ 3.17.0 + + + org.apache.commons + commons-text + jar -+ 1.10.0 ++ 1.12.0 + + + org.apache.httpcomponents @@ -33202,13 +32956,13 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + commons-logging + commons-logging + jar -+ any ++ 1.2 + + + commons-codec + commons-codec + jar -+ any ++ 1.11 + + + org.apache.httpcomponents @@ -33220,37 +32974,43 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + com.thoughtworks.qdox + qdox + jar -+ 2.0.3 ++ 2.1.0 + + + org.codehaus.plexus + plexus-java + jar -+ 1.1.2 ++ 1.3.0 + + + org.ow2.asm + asm + jar -+ 9.2 ++ 9.6 + + + org.codehaus.plexus + plexus-utils + jar -+ 3.5.1 ++ 4.0.2 ++ ++ ++ org.codehaus.plexus ++ plexus-xml ++ jar ++ 3.0.1 + + + org.codehaus.plexus + plexus-io + jar -+ 3.4.1 ++ 3.5.1 + + + org.codehaus.plexus + plexus-archiver + jar -+ 4.8.0 ++ 4.10.0 + + + org.tukaani @@ -33262,25 +33022,470 @@ diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/ma + org.apache.commons + commons-compress + jar -+ 1.23.0 ++ 1.26.2 + + + commons-io + commons-io + jar -+ 2.13.0 ++ 2.17.0 + + + org.codehaus.plexus + plexus-interactivity-api + jar -+ 1.1 -+ -+ -+ org.codehaus.plexus -+ plexus-component-api -+ jar -+ 1.0-alpha-15 ++ 1.3 + + + +--- a/src/main/java/org/apache/maven/plugins/maven_javadoc_plugin/HelpMojo.java 1970-01-01 01:00:00.000000000 +0100 ++++ b/src/main/java/org/apache/maven/plugins/maven_javadoc_plugin/HelpMojo.java 2024-11-04 11:05:47.809358693 +0100 +@@ -0,0 +1,448 @@ ++package org.apache.maven.plugins.maven_javadoc_plugin; ++ ++import org.apache.maven.plugin.AbstractMojo; ++import org.apache.maven.plugin.MojoExecutionException; ++import org.apache.maven.plugins.annotations.Mojo; ++import org.apache.maven.plugins.annotations.Parameter; ++ ++import org.w3c.dom.Document; ++import org.w3c.dom.Element; ++import org.w3c.dom.Node; ++import org.w3c.dom.NodeList; ++import org.xml.sax.SAXException; ++ ++import javax.xml.parsers.DocumentBuilder; ++import javax.xml.parsers.DocumentBuilderFactory; ++import javax.xml.parsers.ParserConfigurationException; ++import java.io.IOException; ++import java.io.InputStream; ++import java.util.ArrayList; ++import java.util.List; ++ ++/** ++ * Display help information on maven-javadoc-plugin.
++ * Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. ++ * @author maven-plugin-tools ++ */ ++@Mojo( name = "help", requiresProject = false, threadSafe = true ) ++public class HelpMojo ++ extends AbstractMojo ++{ ++ /** ++ * If true, display all settable properties for each goal. ++ * ++ */ ++ @Parameter( property = "detail", defaultValue = "false" ) ++ private boolean detail; ++ ++ /** ++ * The name of the goal for which to show help. If unspecified, all goals will be displayed. ++ * ++ */ ++ @Parameter( property = "goal" ) ++ private java.lang.String goal; ++ ++ /** ++ * The maximum length of a display line, should be positive. ++ * ++ */ ++ @Parameter( property = "lineLength", defaultValue = "80" ) ++ private int lineLength; ++ ++ /** ++ * The number of spaces per indentation level, should be positive. ++ * ++ */ ++ @Parameter( property = "indentSize", defaultValue = "2" ) ++ private int indentSize; ++ ++ // /META-INF/maven///plugin-help.xml ++ private static final String PLUGIN_HELP_PATH = ++ "/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml"; ++ ++ private static final int DEFAULT_LINE_LENGTH = 80; ++ ++ private Document build() ++ throws MojoExecutionException ++ { ++ getLog().debug( "load plugin-help.xml: " + PLUGIN_HELP_PATH ); ++ try ( InputStream is = getClass().getResourceAsStream( PLUGIN_HELP_PATH ) ) ++ { ++ if ( is == null ) ++ { ++ throw new MojoExecutionException( "Could not find plugin descriptor at " + PLUGIN_HELP_PATH ); ++ } ++ DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance(); ++ DocumentBuilder dBuilder = dbFactory.newDocumentBuilder(); ++ return dBuilder.parse( is ); ++ } ++ catch ( IOException e ) ++ { ++ throw new MojoExecutionException( e.getMessage(), e ); ++ } ++ catch ( ParserConfigurationException e ) ++ { ++ throw new MojoExecutionException( e.getMessage(), e ); ++ } ++ catch ( SAXException e ) ++ { ++ throw new MojoExecutionException( e.getMessage(), e ); ++ } ++ } ++ ++ /** ++ * {@inheritDoc} ++ */ ++ @Override ++ public void execute() ++ throws MojoExecutionException ++ { ++ if ( lineLength <= 0 ) ++ { ++ getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." ); ++ lineLength = DEFAULT_LINE_LENGTH; ++ } ++ if ( indentSize <= 0 ) ++ { ++ getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." ); ++ indentSize = 2; ++ } ++ ++ Document doc = build(); ++ ++ StringBuilder sb = new StringBuilder(); ++ Node plugin = getSingleChild( doc, "plugin" ); ++ ++ ++ String name = getValue( plugin, "name" ); ++ String version = getValue( plugin, "version" ); ++ String id = getValue( plugin, "groupId" ) + ":" + getValue( plugin, "artifactId" ) + ":" + version; ++ if ( isNotEmpty( name ) && !name.contains( id ) ) ++ { ++ append( sb, name + " " + version, 0 ); ++ } ++ else ++ { ++ if ( isNotEmpty( name ) ) ++ { ++ append( sb, name, 0 ); ++ } ++ else ++ { ++ append( sb, id, 0 ); ++ } ++ } ++ append( sb, getValue( plugin, "description" ), 1 ); ++ append( sb, "", 0 ); ++ ++ //plugin ++ String goalPrefix = getValue( plugin, "goalPrefix" ); ++ ++ Node mojos1 = getSingleChild( plugin, "mojos" ); ++ ++ List mojos = findNamedChild( mojos1, "mojo" ); ++ ++ if ( goal == null || goal.length() <= 0 ) ++ { ++ append( sb, "This plugin has " + mojos.size() + ( mojos.size() > 1 ? " goals:" : " goal:" ), 0 ); ++ append( sb, "", 0 ); ++ } ++ ++ for ( Node mojo : mojos ) ++ { ++ writeGoal( sb, goalPrefix, (Element) mojo ); ++ } ++ ++ if ( getLog().isInfoEnabled() ) ++ { ++ getLog().info( sb.toString() ); ++ } ++ } ++ ++ ++ private static boolean isNotEmpty( String string ) ++ { ++ return string != null && string.length() > 0; ++ } ++ ++ private static String getValue( Node node, String elementName ) ++ throws MojoExecutionException ++ { ++ return getSingleChild( node, elementName ).getTextContent(); ++ } ++ ++ private static Node getSingleChild( Node node, String elementName ) ++ throws MojoExecutionException ++ { ++ List namedChild = findNamedChild( node, elementName ); ++ if ( namedChild.isEmpty() ) ++ { ++ throw new MojoExecutionException( "Could not find " + elementName + " in plugin-help.xml" ); ++ } ++ if ( namedChild.size() > 1 ) ++ { ++ throw new MojoExecutionException( "Multiple " + elementName + " in plugin-help.xml" ); ++ } ++ return namedChild.get( 0 ); ++ } ++ ++ private static List findNamedChild( Node node, String elementName ) ++ { ++ List result = new ArrayList(); ++ NodeList childNodes = node.getChildNodes(); ++ for ( int i = 0; i < childNodes.getLength(); i++ ) ++ { ++ Node item = childNodes.item( i ); ++ if ( elementName.equals( item.getNodeName() ) ) ++ { ++ result.add( item ); ++ } ++ } ++ return result; ++ } ++ ++ private static Node findSingleChild( Node node, String elementName ) ++ throws MojoExecutionException ++ { ++ List elementsByTagName = findNamedChild( node, elementName ); ++ if ( elementsByTagName.isEmpty() ) ++ { ++ return null; ++ } ++ if ( elementsByTagName.size() > 1 ) ++ { ++ throw new MojoExecutionException( "Multiple " + elementName + "in plugin-help.xml" ); ++ } ++ return elementsByTagName.get( 0 ); ++ } ++ ++ private void writeGoal( StringBuilder sb, String goalPrefix, Element mojo ) ++ throws MojoExecutionException ++ { ++ String mojoGoal = getValue( mojo, "goal" ); ++ Node configurationElement = findSingleChild( mojo, "configuration" ); ++ Node description = findSingleChild( mojo, "description" ); ++ if ( goal == null || goal.length() <= 0 || mojoGoal.equals( goal ) ) ++ { ++ append( sb, goalPrefix + ":" + mojoGoal, 0 ); ++ Node deprecated = findSingleChild( mojo, "deprecated" ); ++ if ( ( deprecated != null ) && isNotEmpty( deprecated.getTextContent() ) ) ++ { ++ append( sb, "Deprecated. " + deprecated.getTextContent(), 1 ); ++ if ( detail && description != null ) ++ { ++ append( sb, "", 0 ); ++ append( sb, description.getTextContent(), 1 ); ++ } ++ } ++ else if ( description != null ) ++ { ++ append( sb, description.getTextContent(), 1 ); ++ } ++ append( sb, "", 0 ); ++ ++ if ( detail ) ++ { ++ Node parametersNode = getSingleChild( mojo, "parameters" ); ++ List parameters = findNamedChild( parametersNode, "parameter" ); ++ append( sb, "Available parameters:", 1 ); ++ append( sb, "", 0 ); ++ ++ for ( Node parameter : parameters ) ++ { ++ writeParameter( sb, parameter, configurationElement ); ++ } ++ } ++ } ++ } ++ ++ private void writeParameter( StringBuilder sb, Node parameter, Node configurationElement ) ++ throws MojoExecutionException ++ { ++ String parameterName = getValue( parameter, "name" ); ++ String parameterDescription = getValue( parameter, "description" ); ++ ++ Element fieldConfigurationElement = null; ++ if ( configurationElement != null ) ++ { ++ fieldConfigurationElement = (Element) findSingleChild( configurationElement, parameterName ); ++ } ++ ++ String parameterDefaultValue = ""; ++ if ( fieldConfigurationElement != null && fieldConfigurationElement.hasAttribute( "default-value" ) ) ++ { ++ parameterDefaultValue = " (Default: " + fieldConfigurationElement.getAttribute( "default-value" ) + ")"; ++ } ++ append( sb, parameterName + parameterDefaultValue, 2 ); ++ Node deprecated = findSingleChild( parameter, "deprecated" ); ++ if ( ( deprecated != null ) && isNotEmpty( deprecated.getTextContent() ) ) ++ { ++ append( sb, "Deprecated. " + deprecated.getTextContent(), 3 ); ++ append( sb, "", 0 ); ++ } ++ if ( isNotEmpty( parameterDescription ) ) { ++ append( sb, parameterDescription, 3 ); ++ } ++ if ( "true".equals( getValue( parameter, "required" ) ) ) ++ { ++ append( sb, "Required: Yes", 3 ); ++ } ++ if ( ( fieldConfigurationElement != null ) && isNotEmpty( fieldConfigurationElement.getTextContent() ) ) ++ { ++ String property = getPropertyFromExpression( fieldConfigurationElement.getTextContent() ); ++ append( sb, "User property: " + property, 3 ); ++ } ++ ++ append( sb, "", 0 ); ++ } ++ ++ /** ++ *

Repeat a String n times to form a new string.

++ * ++ * @param str String to repeat ++ * @param repeat number of times to repeat str ++ * @return String with repeated String ++ * @throws NegativeArraySizeException if repeat < 0 ++ * @throws NullPointerException if str is null ++ */ ++ private static String repeat( String str, int repeat ) ++ { ++ StringBuilder buffer = new StringBuilder( repeat * str.length() ); ++ ++ for ( int i = 0; i < repeat; i++ ) ++ { ++ buffer.append( str ); ++ } ++ ++ return buffer.toString(); ++ } ++ ++ /** ++ * Append a description to the buffer by respecting the indentSize and lineLength parameters. ++ * Note: The last character is always a new line. ++ * ++ * @param sb The buffer to append the description, not null. ++ * @param description The description, not null. ++ * @param indent The base indentation level of each line, must not be negative. ++ */ ++ private void append( StringBuilder sb, String description, int indent ) ++ { ++ for ( String line : toLines( description, indent, indentSize, lineLength ) ) ++ { ++ sb.append( line ).append( '\n' ); ++ } ++ } ++ ++ /** ++ * Splits the specified text into lines of convenient display length. ++ * ++ * @param text The text to split into lines, must not be null. ++ * @param indent The base indentation level of each line, must not be negative. ++ * @param indentSize The size of each indentation, must not be negative. ++ * @param lineLength The length of the line, must not be negative. ++ * @return The sequence of display lines, never null. ++ * @throws NegativeArraySizeException if indent < 0 ++ */ ++ private static List toLines( String text, int indent, int indentSize, int lineLength ) ++ { ++ List lines = new ArrayList(); ++ ++ String ind = repeat( "\t", indent ); ++ ++ String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" ); ++ ++ for ( String plainLine : plainLines ) ++ { ++ toLines( lines, ind + plainLine, indentSize, lineLength ); ++ } ++ ++ return lines; ++ } ++ ++ /** ++ * Adds the specified line to the output sequence, performing line wrapping if necessary. ++ * ++ * @param lines The sequence of display lines, must not be null. ++ * @param line The line to add, must not be null. ++ * @param indentSize The size of each indentation, must not be negative. ++ * @param lineLength The length of the line, must not be negative. ++ */ ++ private static void toLines( List lines, String line, int indentSize, int lineLength ) ++ { ++ int lineIndent = getIndentLevel( line ); ++ StringBuilder buf = new StringBuilder( 256 ); ++ ++ String[] tokens = line.split( " +" ); ++ ++ for ( String token : tokens ) ++ { ++ if ( buf.length() > 0 ) ++ { ++ if ( buf.length() + token.length() >= lineLength ) ++ { ++ lines.add( buf.toString() ); ++ buf.setLength( 0 ); ++ buf.append( repeat( " ", lineIndent * indentSize ) ); ++ } ++ else ++ { ++ buf.append( ' ' ); ++ } ++ } ++ ++ for ( int j = 0; j < token.length(); j++ ) ++ { ++ char c = token.charAt( j ); ++ if ( c == '\t' ) ++ { ++ buf.append( repeat( " ", indentSize - buf.length() % indentSize ) ); ++ } ++ else if ( c == '\u00A0' ) ++ { ++ buf.append( ' ' ); ++ } ++ else ++ { ++ buf.append( c ); ++ } ++ } ++ } ++ lines.add( buf.toString() ); ++ } ++ ++ /** ++ * Gets the indentation level of the specified line. ++ * ++ * @param line The line whose indentation level should be retrieved, must not be null. ++ * @return The indentation level of the line. ++ */ ++ private static int getIndentLevel( String line ) ++ { ++ int level = 0; ++ for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ ) ++ { ++ level++; ++ } ++ for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ ) ++ { ++ if ( line.charAt( i ) == '\t' ) ++ { ++ level++; ++ break; ++ } ++ } ++ return level; ++ } ++ ++ private static String getPropertyFromExpression( String expression ) ++ { ++ if ( expression != null && expression.startsWith( "${" ) && expression.endsWith( "}" ) ++ && !expression.substring( 2 ).contains( "${" ) ) ++ { ++ // expression="${xxx}" -> property="xxx" ++ return expression.substring( 2, expression.length() - 1 ); ++ } ++ // no property can be extracted ++ return null; ++ } ++} diff --git a/maven-javadoc-plugin-build.xml b/maven-javadoc-plugin-build.xml index 3a64dc6..e7da58a 100644 --- a/maven-javadoc-plugin-build.xml +++ b/maven-javadoc-plugin-build.xml @@ -14,12 +14,13 @@ value="The Apache Maven Javadoc Plugin is a plugin that uses the javadoc tool for generating javadocs for the specified project."/> - + - + - + + diff --git a/maven-javadoc-plugin.changes b/maven-javadoc-plugin.changes index 65ca0fb..c83f787 100644 --- a/maven-javadoc-plugin.changes +++ b/maven-javadoc-plugin.changes @@ -1,3 +1,135 @@ +------------------------------------------------------------------- +Sun Dec 8 19:49:03 UTC 2024 - Fridrich Strba + +- Upgrade to upstream version 3.11.2 + * New Feature + + MJAVADOC-814: Ability to split grouped packages over multiple + lines + * Improvement + + MJAVADOC-823: legacyMode keeps using module-info.java + (-sourcedirectory still use as well as java files input) + * Task + + MJAVADOC-822: parameter skippedModules should scale and easier + to use + +------------------------------------------------------------------- +Mon Nov 4 10:11:17 UTC 2024 - Fridrich Strba + +- Upgrade to upstream version 3.11.1 +- Version 3.11.1 + * Bug + + MJAVADOC-820: [REGRESSION] MJAVADOC-787 was merged + incompletely + * New Feature + + MJAVADOC-787: Automatic detection of release option for + JDK < 9 + * Task + + MJAVADOC-819: Align archive generation code with Maven Source + Plugin + + MJAVADOC-821: Align toolchain discovery code with Maven + Compiler Plugin + * Dependency upgrade + + MJAVADOC-816: Bump org.codehaus.plexus:plexus-java from + 1.2.0 to 1.3.0 + + MJAVADOC-817: Upgrade to Doxia 2.0.0 GA Stack +- Modified patches: + * maven-javadoc-plugin-bootstrap-resources.patch + + Regenerate from non-bootstrap build + +------------------------------------------------------------------- +Thu Oct 3 22:19:41 UTC 2024 - Fridrich Strba + +- Upgrade to upstream version 3.10.1 +- Version 3.10.1 + * Bug + + MJAVADOC-810: [REGRESSION] MJAVADOC-791 causes forked Maven + execution fail if any toolchains or settings file isn't + present + + MJAVADOC-811: javadoc.bat fails to execute on Windows when + project is not on drive C and AutoRun is configured + + MJAVADOC-812: [REGRESSION] maven-javadoc-plugin 3.10.0 creates + empty JARs +- Version 3.10.0 + * Bug + + MJAVADOC-560: Clarify outputDirectory, reportOutputDirectory + in javadoc:javadoc documentation + * Task + + MJAVADOC-776: Plugin depends on plexus-container-default, + which is EOL + + MJAVADOC-785: Align plugin implementation with + AbstractMavenReport (maven-reporting-impl) + + MJAVADOC-807: Simplify IT for MJAVADOC-498 + + MJAVADOC-809: Align Mojo class names +- Version 3.8.0 + * Bug + + MJAVADOC-603: javadoc:fix failure on JDK10: + java.lang.ClassNotFoundException: java.sql.Connection + + MJAVADOC-751: No warnings for localized output + + MJAVADOC-775: Option 'taglets/taglet/tagletpath' ignored when + pointing to a JAR + + MJAVADOC-783: Invalid path when using TagletArtifact and + TagletPath + + MJAVADOC-791: maven-javadoc-plugin not working correctly + together with maven-toolchains-plugin + * Improvement + + MJAVADOC-796: Do not follow links for Java 12+ + + MJAVADOC-798: Consider passing user settings when using + invoker + + MJAVADOC-802: Set default value of defaultAuthor parameter + in fix goals to ${user.name} + + MJAVADOC-803: Add default parameter to force root locale + * Test + + MJAVADOC-804: Temporary files are left after test execution + * Task + + MJAVADOC-799: Remove inconsistent + 'AbstractFixJavadocMojo#defaultVersion' default value +- Version 3.7.0 + * Bug + + MJAVADOC-793: java.lang.NullPointerException: Cannot invoke + "String.length()" because "text" is null +- Version 3.6.3 + * Bug + + MJAVADOC-682: Reactor builds fail when multiple modules with + same groupId:artifactId, but different versions + + MJAVADOC-780: Unit tests create null-null.jar in build root + directory + * Improvement + + MJAVADOC-779: Upgrade maven-plugin parent to 41 + * Task + + MJAVADOC-782: Align read-only parameters naming with other + plugins +- Version 3.6.2 + * Bug + + MJAVADOC-713: Skipping Javadoc reportset leaves empty Javadoc + link in site + + MJAVADOC-716: The stale file detection does not work + + MJAVADOC-726: Maven Java Doc Plugin downloads Log4j-1.2.12 + dependency transitively + + MJAVADOC-762: createTestRepo in JavaDocReportTest shares state + + MJAVADOC-774: 3.6.0 release is not reproducible + * Improvement + + MJAVADOC-730: Deprecate parameter "old" +- Removed patches: + * no-override.patch + + not needed with this version +- Modified patches: + * maven-javadoc-plugin-bootstrap-resources.patch + + Regenerate using maven-plugin-plugin 3.15 from non-bootstrap + build + * reproducible-from-environment.patch + * stale-data-encoding.patch + + adapt to changed context +- Fetch sources from Github using source service + +------------------------------------------------------------------- +Tue Sep 24 15:00:28 UTC 2024 - Fridrich Strba + +- Added patch: + * reproducible-from-environment.patch + + SOURCE_DATE_EPOCH environmental variable triggers reproducible + use of the maven-javadoc-plugin if it is not requested already + using the project.build.outputTimestamp option. + ------------------------------------------------------------------- Mon Jun 10 16:33:19 UTC 2024 - Fridrich Strba @@ -114,7 +246,7 @@ Tue Oct 25 14:16:58 UTC 2022 - Fridrich Strba * maven-javadoc-plugin-ioexception.patch + allow building with wider range of plexus-utils versions, including the 3.5.0 that does not declare IOException as - thrown in functions where it is actually not thrown. + thrown in functions where it is actually not thrown. ------------------------------------------------------------------- Fri May 13 09:41:52 UTC 2022 - Fridrich Strba diff --git a/maven-javadoc-plugin.spec b/maven-javadoc-plugin.spec index 3da0f1d..2fbaeaf 100644 --- a/maven-javadoc-plugin.spec +++ b/maven-javadoc-plugin.spec @@ -23,17 +23,18 @@ %bcond_with bootstrap %endif %global base_name maven-javadoc-plugin -Version: 3.6.0 +Version: 3.11.2 Release: 0 Summary: Maven plugin for creating javadocs License: Apache-2.0 Group: Development/Libraries/Java URL: https://maven.apache.org/plugins/maven-javadoc-plugin -Source0: https://repo1.maven.org/maven2/org/apache/maven/plugins/%{base_name}/%{version}/%{base_name}-%{version}-source-release.zip +Source0: %{base_name}-%{version}.tar.xz Source1: %{base_name}-build.xml Patch0: %{base_name}-bootstrap-resources.patch Patch1: stale-data-encoding.patch -Patch2: no-override.patch +Patch2: reproducible-from-environment.patch +BuildRequires: apache-commons-io BuildRequires: apache-commons-lang3 BuildRequires: apache-commons-text BuildRequires: atinject @@ -43,16 +44,15 @@ BuildRequires: httpcomponents-core BuildRequires: javapackages-local BuildRequires: maven-archiver BuildRequires: maven-common-artifact-filters -BuildRequires: maven-doxia-core -BuildRequires: maven-doxia-logging-api -BuildRequires: maven-doxia-module-xhtml BuildRequires: maven-doxia-sink-api BuildRequires: maven-doxia-sitetools BuildRequires: maven-invoker BuildRequires: maven-lib BuildRequires: maven-plugin-annotations -BuildRequires: maven-reporting-api >= 3.1.0 +BuildRequires: maven-reporting-api +BuildRequires: maven-reporting-impl BuildRequires: maven-resolver-api +BuildRequires: maven-resolver-impl BuildRequires: maven-resolver-util BuildRequires: maven-shared-utils BuildRequires: maven-wagon-provider-api @@ -65,10 +65,11 @@ BuildRequires: plexus-xml BuildRequires: qdox BuildRequires: sisu-inject BuildRequires: sisu-plexus +BuildRequires: slf4j BuildRequires: unzip BuildRequires: xmvn-install BuildRequires: xmvn-resolve -BuildRequires: mvn(org.apache.maven.plugins:maven-plugins:pom:) +BuildRequires: mvn(org.apache.maven.plugins:maven-plugins:pom:) >= 40 BuildArch: noarch %if %{with bootstrap} Name: %{base_name}-bootstrap @@ -81,7 +82,6 @@ BuildRequires: mvn(org.apache.maven.plugins:maven-compiler-plugin) BuildRequires: mvn(org.apache.maven.plugins:maven-jar-plugin) BuildRequires: mvn(org.apache.maven.plugins:maven-javadoc-plugin) BuildRequires: mvn(org.apache.maven.plugins:maven-plugin-plugin) -BuildRequires: mvn(org.apache.maven.plugins:maven-plugins:pom:) >= 40 BuildRequires: mvn(org.apache.maven.plugins:maven-resources-plugin) BuildRequires: mvn(org.apache.maven.plugins:maven-surefire-plugin) BuildRequires: mvn(org.codehaus.modello:modello-maven-plugin) @@ -117,9 +117,6 @@ cp %{SOURCE1} build.xml %patch -P 1 -p1 %patch -P 2 -p1 -%pom_add_dep org.codehaus.plexus:plexus-xml:3.0.0 - -%pom_xpath_remove pom:project/pom:parent/pom:relativePath %pom_remove_dep :::test: %build @@ -134,10 +131,9 @@ build-jar-repository -s lib \ maven-archiver/maven-archiver \ maven-common-artifact-filters/maven-common-artifact-filters \ maven-doxia/doxia-core \ - maven-doxia/doxia-logging-api \ - maven-doxia/doxia-module-xhtml \ maven-doxia/doxia-module-xhtml5 \ maven-doxia/doxia-sink-api \ + maven-doxia-sitetools/doxia-integration-tools \ maven-doxia-sitetools/doxia-site-renderer \ maven-invoker/maven-invoker \ maven/maven-artifact \ @@ -160,8 +156,9 @@ build-jar-repository -s lib \ plexus-languages/plexus-java \ plexus/utils \ plexus/xml \ - qdox -%{ant} -Dtest.skip=true jar + qdox \ + slf4j/api +ant -Dtest.skip=true jar %else xmvn --batch-mode --offline \ -Dmaven.test.skip=true -DmavenVersion=3.5.0 \ @@ -178,13 +175,9 @@ xmvn --batch-mode --offline \ %fdupes -s %{buildroot}%{_javadocdir} %files -f .mfiles -%license LICENSE -%doc NOTICE %if %{without bootstrap} %files javadoc -f .mfiles-javadoc -%license LICENSE -%doc NOTICE %endif %changelog diff --git a/no-override.patch b/no-override.patch deleted file mode 100644 index c72e70b..0000000 --- a/no-override.patch +++ /dev/null @@ -1,10 +0,0 @@ ---- maven-javadoc-plugin-3.5.0/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java 2023-09-14 14:27:44.286360008 +0200 -+++ maven-javadoc-plugin-3.5.0/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java 2023-09-14 14:34:08.848960654 +0200 -@@ -118,7 +118,6 @@ - } - - /** {@inheritDoc} */ -- @Override - public void generate(org.codehaus.doxia.sink.Sink sink, Locale locale) throws MavenReportException { - generate(sink, null, locale); - } diff --git a/reproducible-from-environment.patch b/reproducible-from-environment.patch new file mode 100644 index 0000000..abb0d0e --- /dev/null +++ b/reproducible-from-environment.patch @@ -0,0 +1,17 @@ +--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java ++++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java +@@ -2692,6 +2692,14 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { + private String getBottomText() { + final String inceptionYear = project.getInceptionYear(); + ++ if ( outputTimestamp == null || ++ outputTimestamp.length() < 1 || ++ ( ( outputTimestamp.length() == 1 ) ++ && !Character.isDigit( outputTimestamp.charAt(0) ) ) ) ++ { ++ outputTimestamp = System.getenv("SOURCE_DATE_EPOCH"); ++ } ++ + // get Reproducible Builds outputTimestamp date value or the current local date. + final LocalDate localDate = MavenArchiver.parseBuildOutputTimestamp(outputTimestamp) + .map(instant -> instant.atZone(ZoneOffset.UTC).toLocalDate()) diff --git a/stale-data-encoding.patch b/stale-data-encoding.patch index 3f55c4d..4a6dd83 100644 --- a/stale-data-encoding.patch +++ b/stale-data-encoding.patch @@ -1,6 +1,6 @@ ---- maven-javadoc-plugin-3.5.0/src/main/java/org/apache/maven/plugins/javadoc/StaleHelper.java 2023-09-14 14:20:14.049981880 +0200 -+++ maven-javadoc-plugin-3.5.0/src/main/java/org/apache/maven/plugins/javadoc/StaleHelper.java 2023-09-14 14:25:18.258705774 +0200 -@@ -41,6 +41,19 @@ +--- a/src/main/java/org/apache/maven/plugins/javadoc/StaleHelper.java ++++ b/src/main/java/org/apache/maven/plugins/javadoc/StaleHelper.java +@@ -40,6 +40,19 @@ import org.codehaus.plexus.util.cli.Commandline; */ public class StaleHelper { @@ -20,7 +20,7 @@ /** * Compute the data used to detect a stale javadoc * -@@ -56,13 +69,7 @@ +@@ -55,13 +68,7 @@ public class StaleHelper { String[] args = cmd.getArguments(); Collections.addAll(options, args); @@ -35,18 +35,16 @@ for (String arg : args) { if (arg.startsWith("@")) { -@@ -116,9 +123,11 @@ +@@ -115,9 +122,11 @@ public class StaleHelper { */ public static void writeStaleData(Commandline cmd, Path path) throws MavenReportException { try { + final Charset cs = getDataCharset(); + - String curdata = getStaleData(cmd); + List curdata = getStaleData(cmd); Files.createDirectories(path.getParent()); -- Files.write(path, Collections.singleton(curdata), Charset.defaultCharset()); -+ Files.write(path, Collections.singleton(curdata), cs); +- Files.write(path, curdata, StandardCharsets.UTF_8); ++ Files.write(path, curdata, cs); } catch (IOException e) { throw new MavenReportException("Error checking stale data", e); } -Only in maven-javadoc-plugin-3.5.0/src/main/java/org/apache/maven/plugins/javadoc: StaleHelper.java.orig -Only in maven-javadoc-plugin-3.5.0/src/main/java/org/apache/maven/plugins/javadoc: StaleHelper.java.rej