Modified: maven/website/components/plugins-archives/maven-javadoc-plugin-LATEST/aggregate-no-fork-mojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-javadoc-plugin-LATEST/aggregate-no-fork-mojo.html (original) +++ maven/website/components/plugins-archives/maven-javadoc-plugin-LATEST/aggregate-no-fork-mojo.html Thu Aug 22 16:59:20 2024 @@ -2,8 +2,8 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.12.0:report at 2024-07-17 - | Rendered using Apache Maven Fluido Skin 1.11.2 + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.13.1:report at 2024-08-22 + | Rendered using Apache Maven Fluido Skin 1.12.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> @@ -11,10 +11,10 @@ <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> <title>Apache Maven Javadoc Plugin – javadoc:aggregate-no-fork</title> - <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.2.min.css" /> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.12.0.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> - <script src="./js/apache-maven-fluido-1.11.2.min.js"></script> + <script src="./js/apache-maven-fluido-1.12.0.min.js"></script> <!-- Matomo --> <script> @@ -33,12 +33,12 @@ </script> <!-- End Matomo Code --> </head> - <body class="topBarDisabled"> - <div class="container-fluid"> + <body> + <div class="container-fluid container-fluid-top"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Javadoc Plugin" style="" /></a></div> - <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" style="" /></a></div> + <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -49,8 +49,8 @@ <li><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> <li><a href="index.html" title="Apache Maven Javadoc Plugin">Apache Maven Javadoc Plugin</a><span class="divider">/</span></li> <li class="active ">javadoc:aggregate-no-fork</li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-07-17</li> - <li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 3.8.0</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-08-22</li> + <li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 3.10.0</li> <li class="pull-right"><a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink" title="Javadoc Tool">Javadoc Tool</a></li> </ul> </div> @@ -96,7 +96,7 @@ <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="" title=""><span class="icon-chevron-down"></span></a> + <li><a href="" title="Components"><span class="icon-chevron-down"></span>Components</a> <ul class="nav nav-list"> <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> @@ -134,7 +134,7 @@ <p><strong>Note</strong>:</p> <p>This goal should be used as a Maven report.</p> <p><strong>Full name</strong>:</p> -<p>org.apache.maven.plugins:maven-javadoc-plugin:3.8.0:aggregate-no-fork</p> +<p>org.apache.maven.plugins:maven-javadoc-plugin:3.10.0:aggregate-no-fork</p> <p><strong>Description</strong>:</p> <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> <p><strong>Attributes</strong>:</p> @@ -154,12 +154,7 @@ <td align="left"><a href="#outputDirectory"><code><outputDirectory></code></a></td> <td><code>File</code></td> <td><code>-</code></td> -<td>Specifies the destination directory where javadoc saves the generated HTML files.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet";>Doclet option d</a><br /><strong>Default</strong>: <code>${project.build.directory}/apidocs</code><br /><strong>User Property</strong>: <code>destDir</code><br /><strong>Alias</strong>: <code>destDir</code></td></tr> -<tr class="a"> -<td align="left"><a href="#reportOutputDirectory"><code><reportOutputDirectory></code></a></td> -<td><code>File</code></td> -<td><code>-</code></td> -<td>Specifies the destination directory where javadoc saves the generated HTML files.<br /><strong>Default</strong>: <code>${project.reporting.outputDirectory}/apidocs</code><br /><strong>User Property</strong>: <code>reportOutputDirectory</code></td></tr></table></section><section> +<td>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 <a href="https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory";>Maven Site Plugin</a> is used instead.<br /><strong>See also:</strong> org.apache.maven.reporting.AbstractMavenReport.outputDirectory, <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet";>Doclet option d</a><br /><strong>Default</strong>: <code>${project.build.directory}/reports</code></td></tr></table></section><section> <h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_Parameters"></a> <table border="0" class="table table-striped"> <tr class="a"> @@ -304,19 +299,13 @@ <td><code>2.1</code></td> <td>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. <code>project-reports.html</code>).<br /><strong>User Property</strong>: <code>description</code></td></tr> <tr class="a"> -<td align="left"><a href="#destDir"><code><destDir></code></a></td> -<td><code>String</code></td> -<td><code>2.1</code></td> -<td>The name of the destination directory. -<br /><br /><strong>Default</strong>: <code>apidocs</code><br /><strong>User Property</strong>: <code>destDir</code></td></tr> -<tr class="b"> <td align="left"><a href="#detectJavaApiLink"><code><detectJavaApiLink></code></a></td> <td><code>boolean</code></td> <td><code>2.6</code></td> <td>Detect the Java API link for the current build, e.g. <code>https://docs.oracle.com/javase/1.4.2/docs/api/</code> for Java source 1.4. <br /> By default, the goal detects the Javadoc API link depending the value of the <code>source</code> parameter in the <code>org.apache.maven.plugins:maven-compiler-plugin</code> (defined in <code>${project.build.plugins}</code> or in <code>${project.build.pluginManagement}</code>), or try to compute it from the <code>javadocExecutable</code> version.<br /><strong>See also:</strong> <a href="#links">links</a>, <a href="#javaApiLinks">javaApiLinks</a><br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>detectJavaApiLink</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#detectLinks"><code><detectLinks></code></a></td> <td><code>boolean</code></td> <td><code>2.6</code></td> @@ -329,7 +318,7 @@ <artifactId>commons-lang</artifactId> </dependency> </pre> The added Javadoc <code>-link</code> parameter will be <code>http://commons.apache.org/lang/apidocs</code>.<br /><strong>See also:</strong> <a href="#links">links</a>, <a href="#dependencyLinks">dependencyLinks</a><br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>detectLinks</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#detectOfflineLinks"><code><detectOfflineLinks></code></a></td> <td><code>boolean</code></td> <td><code>2.6</code></td> @@ -340,22 +329,22 @@ The added Javadoc <code>-linkoffline</code> parameter for <b>module1</b> will be <code>/absolute/path/to/</code><b>module2</b><code>/target/site/apidocs</code> <br /> The added Javadoc <code>-linkoffline</code> parameter for <b>module2</b> will be <code>/absolute/path/to/</code><b>module1</b><code>/target/site/apidocs</code><br /><strong>See also:</strong> <a href="#offlineLinks">offlineLinks</a><br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>detectOfflineLinks</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#docencoding"><code><docencoding></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be <code>UTF-8</code>.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option docencoding</a>.<br /><strong>Default</strong>: <code>${project.reporting.outputEncoding}</code><br /><strong>User Property</strong>: <code>docencoding</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#docfilessubdirs"><code><docfilessubdirs></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Enables deep copying of the <code>**/doc-files</code> directories and the specifc <code>resources</code> directory from the <code>javadocDirectory</code> directory (for instance, <code>src/main/javadoc/com/mycompany/myapp/doc-files</code> and <code>src/main/javadoc/resources</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option docfilessubdirs</a>., <a href="#excludedocfilessubdir">excludedocfilessubdir</a>, <a href="#javadocDirectory">javadocDirectory</a><br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>docfilessubdirs</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#doclet"><code><doclet></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the class file that starts the doclet used in generating the documentation.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option doclet</a>.<br /><strong>User Property</strong>: <code>doclet</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#docletArtifact"><code><docletArtifact></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/options/DocletArtifact.html"><code>DocletArtifact</code></a></td> <td><code>-</code></td> @@ -372,7 +361,7 @@ <br /> See <a href="./apidocs/org/apache/maven/plugins/javadoc/options/DocletArtifact.html">Javadoc</a>. <br /><br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option docletpath</a>.<br /><strong>User Property</strong>: <code>docletArtifact</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#docletArtifacts"><code><docletArtifacts></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/options/DocletArtifact.html"><code>DocletArtifact[]</code></a></td> <td><code>2.1</code></td> @@ -391,28 +380,28 @@ <br /> See <a href="./apidocs/org/apache/maven/plugins/javadoc/options/DocletArtifact.html">Javadoc</a>. <br /><br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option docletpath</a>.<br /><strong>User Property</strong>: <code>docletArtifacts</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#docletPath"><code><docletPath></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the path to the doclet starting class file (specified with the <a href="#doclet"><code>doclet</code></a> option) and any jar files it depends on. The <code>docletPath</code> can contain multiple paths by separating them with a colon (<code>:</code>) or a semicolon (<code>;</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option docletpath</a>.<br /><strong>User Property</strong>: <code>docletPath</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#doclint"><code><doclint></code></a></td> <td><code>String</code></td> <td><code>3.0.0</code></td> <td>Specifies specific checks to be performed on Javadoc comments.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet";>Additional Doclet option Xdoclint</a>.<br /><strong>User Property</strong>: <code>doclint</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#doctitle"><code><doctitle></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the title to be placed near the top of the overview summary file.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option doctitle</a>.<br /><strong>Default</strong>: <code>${project.name} ${project.version} API</code><br /><strong>User Property</strong>: <code>doctitle</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#encoding"><code><encoding></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the <code>file.encoding</code> system property. <br /><b>Note</b>: In 2.4, the default value was locked to <code>ISO-8859-1</code> to ensure reproducing build, but this was reverted in 2.5.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding";>Javadoc option encoding</a>.<br /><strong>Default</strong>: <code>${project.build.sourceEncoding}</code><br /><strong>User Property</strong>: <code>encoding</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#excludePackageNames"><code><excludePackageNames></code></a></td> <td><code>String</code></td> <td><code>-</code></td> @@ -426,37 +415,37 @@ <pre> <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames> </pre><br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option exclude</a>.<br /><strong>User Property</strong>: <code>excludePackageNames</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#excludedocfilessubdir"><code><excludedocfilessubdir></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (<code>:</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option excludedocfilessubdir</a>., <a href="#docfilessubdirs">docfilessubdirs</a><br /><strong>User Property</strong>: <code>excludedocfilessubdir</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#extdirs"><code><extdirs></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the directories where extension classes reside. Separate directories in <code>extdirs</code> with a colon (<code>:</code>) or a semicolon (<code>;</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs";>Javadoc option extdirs</a>.<br /><strong>User Property</strong>: <code>extdirs</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#failOnError"><code><failOnError></code></a></td> <td><code>boolean</code></td> <td><code>2.5</code></td> <td>Specifies if the build will fail if there are errors during javadoc execution or not.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>maven.javadoc.failOnError</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#failOnWarnings"><code><failOnWarnings></code></a></td> <td><code>boolean</code></td> <td><code>3.0.1</code></td> <td>Specifies if the build will fail if there are warning during javadoc execution or not.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>maven.javadoc.failOnWarnings</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#footer"><code><footer></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the footer text to be placed at the bottom of each output file.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option footer</a>.<br /><strong>User Property</strong>: <code>footer</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#forceRootLocale"><code><forceRootLocale></code></a></td> <td><code>boolean</code></td> <td><code>3.8.0</code></td> <td>Forces the Javadoc JVM locale to be <code>java.util.Locale.ROOT</code><!-- reference not found in associated javadoc sites -->. This will force the Javadoc output on <code>stdout</code> and <code>stderr</code> 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 <a href="#locale"><code>locale</code></a>.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>forceRootLocale</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#groups"><code><groups></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/options/Group.html"><code>Group[]</code></a></td> <td><code>-</code></td> @@ -480,12 +469,12 @@ </group> </groups> </pre><b>Note</b>: using <code>java.lang.*</code> for <code>packages</code> would omit the <code>java.lang</code> package but using <code>java.lang*</code> will include it.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option group</a>., <a href="apidocs/org/apache/maven/plugins/javadoc/options/Group.html">org.apache.maven.plugins.javadoc.options.Group</a></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#header"><code><header></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the header text to be placed at the top of each output file.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option header</a>.<br /><strong>User Property</strong>: <code>header</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#helpfile"><code><helpfile></code></a></td> <td><code>String</code></td> <td><code>-</code></td> @@ -520,18 +509,18 @@ <plugins> </build> </pre> Where <code>path/to/your/resource/yourhelp-doc.html</code> is defined in the <code>groupId:artifactId:version</code> javadoc plugin dependency.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option helpfile</a>.<br /><strong>User Property</strong>: <code>helpfile</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#includeDependencySources"><code><includeDependencySources></code></a></td> <td><code>boolean</code></td> <td><code>2.7</code></td> <td>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.<br /><strong>Default</strong>: <code>false</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#includeTransitiveDependencySources"><code><includeTransitiveDependencySources></code></a></td> <td><code>boolean</code></td> <td><code>2.7</code></td> <td> <div><strong>Deprecated.</strong><br />if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies</div><br />Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.<br /><strong>See also:</strong> <a href="#includeDependencySources">includeDependencySources</a><br /><strong>Default</strong>: <code>false</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#javaApiLinks"><code><javaApiLinks></code></a></td> <td><code>Properties</code></td> <td><code>2.6</code></td> @@ -558,7 +547,7 @@ https://docs.oracle.com/javase/9/docs/api/ </dd> </dl><br /><strong>User Property</strong>: <code>javaApiLinks</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#javadocDirectory"><code><javadocDirectory></code></a></td> <td><code>File</code></td> <td><code>2.1</code></td> @@ -567,17 +556,17 @@ Could be used in addition of <code>docfilessubdirs</code> parameter. <br /> See <a href="#docfilessubdirs">docfilessubdirs</a>.<br /><strong>See also:</strong> <a href="#docfilessubdirs">docfilessubdirs</a><br /><strong>Default</strong>: <code>${basedir}/src/main/javadoc</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#javadocExecutable"><code><javadocExecutable></code></a></td> <td><code>String</code></td> <td><code>2.3</code></td> <td>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.<br /><strong>User Property</strong>: <code>javadocExecutable</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#javadocVersion"><code><javadocVersion></code></a></td> <td><code>String</code></td> <td><code>2.3</code></td> <td>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".<br /><strong>User Property</strong>: <code>javadocVersion</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#jdkToolchain"><code><jdkToolchain></code></a></td> <td><code>Map<String,String></code></td> <td><code>3.0.0</code></td> @@ -601,17 +590,17 @@ </configuration> </code> </pre><strong>note:</strong> requires at least Maven 3.3.1</td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#keywords"><code><keywords></code></a></td> <td><code>boolean</code></td> <td><code>2.1</code></td> <td>Adds HTML meta keyword tags to the generated file for each class.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option keywords</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>keywords</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#legacyMode"><code><legacyMode></code></a></td> <td><code>boolean</code></td> <td><code>3.6.0</code></td> <td>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.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>legacyMode</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#links"><code><links></code></a></td> <td><code>ArrayList<String></code></td> <td><code>-</code></td> @@ -628,65 +617,65 @@ <li>If <a href="#detectLinks"><code>detectLinks</code></a> is defined, the links between the project dependencies are automatically added.</li> <li>If <a href="#detectJavaApiLink"><code>detectJavaApiLink</code></a> is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.</li> </ol><br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option link</a><br /><strong>User Property</strong>: <code>links</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#linksource"><code><linksource></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option linksource/a>. <br /></a><br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>linksource</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#locale"><code><locale></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the locale that javadoc uses when generating documentation.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option locale</a>.<br /><strong>User Property</strong>: <code>locale</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#maxmemory"><code><maxmemory></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the <code>-Xmx</code> parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: <code>k</code>, <code>kb</code>, <code>m</code>, <code>mb</code>, <code>g</code>, <code>gb</code>, <code>t</code>, <code>tb</code>. If no unit specified, the default unit is <code>m</code>.<br /><strong>User Property</strong>: <code>maxmemory</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#minmemory"><code><minmemory></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the <code>-Xms</code> parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: <code>k</code>, <code>kb</code>, <code>m</code>, <code>mb</code>, <code>g</code>, <code>gb</code>, <code>t</code>, <code>tb</code>. If no unit specified, the default unit is <code>m</code>.<br /><strong>User Property</strong>: <code>minmemory</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#name"><code><name></code></a></td> <td><code>String</code></td> <td><code>2.1</code></td> <td>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. <code>project-reports.html</code>).<br /><strong>User Property</strong>: <code>name</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#nocomment"><code><nocomment></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Suppress the entire comment body, including the main description and all tags, generating only declarations.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option nocomment</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>nocomment</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#nodeprecated"><code><nodeprecated></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Prevents the generation of any deprecated API at all in the documentation.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option nodeprecated</a>. <br /><br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>nodeprecated</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#nodeprecatedlist"><code><nodeprecatedlist></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>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.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";> Doclet option nodeprecatedlist</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>nodeprecatedlist</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#nohelp"><code><nohelp></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Omits the HELP link in the navigation bars at the top and bottom of each page of output. <br /><b>Note</b>: could be in conflict with <a href="#helpfile"><code>helpfile</code></a>.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option nohelp</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>nohelp</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#noindex"><code><noindex></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Omits the index from the generated docs. <br /><b>Note</b>: could be in conflict with <a href="#splitindex"><code>splitindex</code></a><br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option noindex</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>noindex</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#nonavbar"><code><nonavbar></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Omits the navigation bar from the generated docs.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option nonavbar</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>nonavbar</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#nooverview"><code><nooverview></code></a></td> <td><code>boolean</code></td> <td><code>2.4</code></td> @@ -695,7 +684,7 @@ <br /> Standard Doclet undocumented option. <br /><br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>nooverview</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#noqualifier"><code><noqualifier></code></a></td> <td><code>String</code></td> <td><code>-</code></td> @@ -705,29 +694,29 @@ or <noqualifier>packagename1:packagename2</noqualifier> </pre><br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option noqualifier</a>.<br /><strong>User Property</strong>: <code>noqualifier</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#nosince"><code><nosince></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Omits from the generated docs the "Since" sections associated with the since tags.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option nosince</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>nosince</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#notimestamp"><code><notimestamp></code></a></td> <td><code>boolean</code></td> <td><code>2.1</code></td> <td>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page. <br /> <br /><strong>Note:</strong> If the project has the property <code>project.build.outputTimestamp</code>, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option notimestamp</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>notimestamp</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#notree"><code><notree></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Omits the class/interface hierarchy pages from the generated docs.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option notree</a><br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>notree</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#offline"><code><offline></code></a></td> <td><code>boolean</code></td> <td><code>3.6.0</code></td> <td>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using <code>-o</code> or <code>--offline</code> on the command line), this option has no effect and the plugin is always in offline mode.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>maven.javadoc.offline</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#offlineLinks"><code><offlineLinks></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/options/OfflineLink.html"><code>OfflineLink[]</code></a></td> <td><code>-</code></td> @@ -743,30 +732,30 @@ or </offlineLinks> </pre> <br /><b>Note</b>: if <a href="#detectOfflineLinks"><code>detectOfflineLinks</code></a> is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.<br /><strong>See also:</strong> <a href="apidocs/org/apache/maven/plugins/javadoc/options/OfflineLink.html">org.apache.maven.plugins.javadoc.options.OfflineLink</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet";>Doclet option linkoffline</a><br /><strong>User Property</strong>: <code>offlineLinks</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#old"><code><old></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td> <div><strong>Deprecated.</strong><br />No reason given</div><br />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)<br /><strong>See also:</strong> <a href="https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1";>Javadoc option 1.1</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>old</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#outputTimestamp"><code><outputTimestamp></code></a></td> <td><code>String</code></td> <td><code>3.2.0</code></td> <td>Timestamp for reproducible output archive entries, either formatted as ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ssXXX</code> or as an int representing seconds since the epoch (like <a href="https://reproducible-builds.org/docs/source-date-epoch/";>SOURCE_DATE_EPOCH</a>).<br /><strong>Default</strong>: <code>${project.build.outputTimestamp}</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#overview"><code><overview></code></a></td> <td><code>File</code></td> <td><code>-</code></td> <td>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). <br /><b>Note</b>: could be in conflict with <a href="#nooverview"><code>nooverview</code></a>.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Javadoc option overview</a>. <br /><br /><strong>Default</strong>: <code>${basedir}/src/main/javadoc/overview.html</code><br /><strong>User Property</strong>: <code>overview</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#packagesheader"><code><packagesheader></code></a></td> <td><code>String</code></td> <td><code>2.1</code></td> <td>Specify the text for upper left frame.<br /><strong>See also:</strong> <a href="https://bugs.openjdk.org/browse/JDK-4770521";>Bug Report about missing documentation</a><br /><strong>User Property</strong>: <code>packagesheader</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#quiet"><code><quiet></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> @@ -775,12 +764,12 @@ or Note: was a standard doclet in Java 1.4.2 (refer to bug ID <a href="https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350";>4714350</a>). <br /> Since Java 5.0.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option quiet</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>quiet</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#release"><code><release></code></a></td> <td><code>String</code></td> <td><code>JDK 9</code></td> <td>Provide source compatibility with specified release<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release";>Javadoc option release</a>.<br /><strong>Default</strong>: <code>${maven.compiler.release}</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#resourcesArtifacts"><code><resourcesArtifacts></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/options/ResourcesArtifact.html"><code>ResourcesArtifact[]</code></a></td> <td><code>2.5</code></td> @@ -799,12 +788,12 @@ or <br /> See <a href="./apidocs/org/apache/maven/plugins/javadoc/options/ResourcesArtifact.html">Javadoc</a>. <br /><br /><strong>User Property</strong>: <code>resourcesArtifacts</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#serialwarn"><code><serialwarn></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Generates compile-time warnings for missing serial tags.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option serialwarn</a><br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>serialwarn</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#show"><code><show></code></a></td> <td><code>String</code></td> <td><code>-</code></td> @@ -815,58 +804,58 @@ or <li>package (shows all classes and members not marked private)</li> <li>private (shows all classes and members)</li> </ul><br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc options private, protected, public and package</a><br /><strong>Default</strong>: <code>protected</code><br /><strong>User Property</strong>: <code>show</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#skip"><code><skip></code></a></td> <td><code>boolean</code></td> <td><code>2.5</code></td> <td>Specifies whether the Javadoc generation should be skipped.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>maven.javadoc.skip</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#skippedModules"><code><skippedModules></code></a></td> <td><code>String</code></td> <td><code>3.2.0</code></td> <td><p>Comma separated list of modules (artifactId) to not add in aggregated javadoc</p><br /><strong>User Property</strong>: <code>maven.javadoc.skippedModules</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#source"><code><source></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Provide source compatibility with specified release. Since JDK 9 rather use <a href="#release"><code>release</code></a>.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source";>Javadoc option source</a>.<br /><strong>Default</strong>: <code>${maven.compiler.source}</code><br /><strong>User Property</strong>: <code>source</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#sourceDependencyCacheDir"><code><sourceDependencyCacheDir></code></a></td> <td><code>File</code></td> <td><code>2.7</code></td> <td>Directory where unpacked project sources / test-sources should be cached.<br /><strong>See also:</strong> <a href="#includeDependencySources">includeDependencySources</a><br /><strong>Default</strong>: <code>${project.build.directory}/distro-javadoc-sources</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#sourceFileExcludes"><code><sourceFileExcludes></code></a></td> <td><code>List<String></code></td> <td><code>2.9</code></td> <td>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#sourceFileIncludes"><code><sourceFileIncludes></code></a></td> <td><code>List<String></code></td> <td><code>2.9</code></td> <td>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#sourcepath"><code><sourcepath></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the source paths where the subpackages are located. The <code>sourcepath</code> can contain multiple paths by separating them with a colon (<code>:</code>) or a semicolon (<code>;</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path";>Javadoc option sourcepath</a>.<br /><strong>User Property</strong>: <code>sourcepath</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#sourcetab"><code><sourcetab></code></a></td> <td><code>int</code></td> <td><code>2.1</code></td> <td>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option sourcetab</a><br /><strong>User Property</strong>: <code>sourcetab</code><br /><strong>Alias</strong>: <code>linksourcetab</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#splitindex"><code><splitindex></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>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. <br /><b>Note</b>: could be in conflict with <a href="#noindex"><code>noindex</code></a>.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option splitindex</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>splitindex</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#staleDataPath"><code><staleDataPath></code></a></td> <td><code>File</code></td> <td><code>3.2.0</code></td> <td><p>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.</p><br /><strong>Default</strong>: <code>${project.build.directory}/maven-javadoc-plugin-stale-data.txt</code><br /><strong>User Property</strong>: <code>staleDataPath</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#stylesheet"><code><stylesheet></code></a></td> <td><code>String</code></td> <td><code>-</code></td> @@ -874,7 +863,7 @@ or <div><strong>Deprecated.</strong><br />This is no longer evaluated, instead use <a href="#addStylesheets"><code>addStylesheets</code></a> to customize the CSS.</div><br />Specifies whether the stylesheet to be used is the <code>maven</code>'s javadoc stylesheet or <code>java</code>'s default stylesheet when a <a href="#stylesheetfile"><code>stylesheetfile</code></a> parameter is not specified. <br /> Possible values: <code>maven<code> or <code>java</code>.</code></code><br /><strong>Default</strong>: <code>java</code><br /><strong>User Property</strong>: <code>stylesheet</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#stylesheetfile"><code><stylesheetfile></code></a></td> <td><code>String</code></td> <td><code>-</code></td> @@ -908,17 +897,17 @@ or <plugins> </build> </pre> Where <code>path/to/your/resource/yourstylesheet.css</code> is defined in the <code>groupId:artifactId:version</code> javadoc plugin dependency.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option stylesheetfile</a>.<br /><strong>User Property</strong>: <code>stylesheetfile</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#subpackages"><code><subpackages></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (<code>:</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option subpackages</a>.<br /><strong>User Property</strong>: <code>subpackages</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#taglet"><code><taglet></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the class file that starts the taglet used in generating the documentation for that tag.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option taglet</a>.<br /><strong>User Property</strong>: <code>taglet</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#tagletArtifact"><code><tagletArtifact></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/options/TagletArtifact.html"><code>TagletArtifact</code></a></td> <td><code>2.1</code></td> @@ -943,7 +932,7 @@ or </pre> <br /> See <a href="./apidocs/org/apache/maven/plugins/javadoc/options/TagletArtifact.html">Javadoc</a>.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option tagletpath</a>.<br /><strong>User Property</strong>: <code>tagletArtifact</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#tagletArtifacts"><code><tagletArtifacts></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/options/TagletArtifact.html"><code>TagletArtifact[]</code></a></td> <td><code>2.5</code></td> @@ -962,12 +951,12 @@ or </pre> <br /> See <a href="./apidocs/org/apache/maven/plugins/javadoc/options/TagletArtifact.html">Javadoc</a>.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet options taglet and tagletpath</a><br /><strong>User Property</strong>: <code>tagletArtifacts</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#tagletpath"><code><tagletpath></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the search paths for finding taglet class files (.class). The <code>tagletpath</code> can contain multiple paths by separating them with a colon (<code>:</code>) or a semicolon (<code>;</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option tagletpath</a>.<br /><strong>User Property</strong>: <code>tagletpath</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#taglets"><code><taglets></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/options/Taglet.html"><code>Taglet[]</code></a></td> <td><code>2.1</code></td> @@ -990,7 +979,7 @@ or <br /> See <a href="./apidocs/org/apache/maven/plugins/javadoc/options/Taglet.html">Javadoc</a>. <br /><br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet options taglet and tagletpath</a><br /><strong>User Property</strong>: <code>taglets</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#tags"><code><tags></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/options/Tag.html"><code>Tag[]</code></a></td> <td><code>-</code></td> @@ -1016,17 +1005,17 @@ or <li><b><code>m</code></b> (methods)</li> <li><b><code>f</code></b> (fields)</li> </ul> See <a href="./apidocs/org/apache/maven/plugins/javadoc/options/Tag.html">Javadoc</a>.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option tag</a>.<br /><strong>User Property</strong>: <code>tags</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#top"><code><top></code></a></td> <td><code>String</code></td> <td><code>2.4</code></td> <td>Specifies the top text to be placed at the top of each output file.<br /><strong>See also:</strong> <a href="https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616";>Java Bug 6227616</a>., <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option top</a>.<br /><strong>User Property</strong>: <code>top</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#use"><code><use></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Includes one "Use" page for each documented class and package.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option use</a>.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>use</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#useStandardDocletOptions"><code><useStandardDocletOptions></code></a></td> <td><code>boolean</code></td> <td><code>2.5</code></td> @@ -1043,28 +1032,28 @@ or </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </pre><br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>useStandardDocletOptions</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#validateLinks"><code><validateLinks></code></a></td> <td><code>boolean</code></td> <td><code>2.8</code></td> -<td>Flag controlling content validation of <code>package-list</code> resources. If set, the content of <code>package-list</code> resources will be validated.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>validateLinks</code></td></tr> -<tr class="b"> +<td>Flag controlling content validation of <code>package-list</code>/<code>element-list</code> resources. If set, the content of <code>package-list</code>/<code>element-list</code> resources will be validated.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>validateLinks</code></td></tr> +<tr class="a"> <td align="left"><a href="#verbose"><code><verbose></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Provides more detailed messages while javadoc is running.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option verbose</a>.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>verbose</code></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#version"><code><version></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Includes the given version text in the generated docs.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option version</a>.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>version</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#windowtitle"><code><windowtitle></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Specifies the title to be placed in the HTML title tag.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option windowtitle</a>.<br /><strong>Default</strong>: <code>${project.name} ${project.version} API</code><br /><strong>User Property</strong>: <code>windowtitle</code></td></tr></table></section><section> -<h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="addStylesheets"><section> -<h4><a name="a.3CaddStylesheets.3E"></a><addStylesheets></h4><a name="a.3CaddStylesheets.3E"></a></a> +<h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="addStylesheets"></a><section> +<h4><a name="a.3CaddStylesheets.3E"></a><addStylesheets></h4><a name="a.3CaddStylesheets.3E"></a> <div>Specifies the path of an additional HTML stylesheet file relative to the <code>javadocDirectory</code> Example: <pre> <addStylesheets> @@ -1074,8 +1063,8 @@ or <ul> <li><strong>Type</strong>: <code>java.lang.String[]</code></li> <li><strong>Since</strong>: <code>3.3.0</code></li> -<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="additionalDependencies"><section> -<h4><a name="a.3CadditionalDependencies.3E"></a><additionalDependencies></h4><a name="a.3CadditionalDependencies.3E"></a></a> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="additionalDependencies"></a><section> +<h4><a name="a.3CadditionalDependencies.3E"></a><additionalDependencies></h4><a name="a.3CadditionalDependencies.3E"></a> <div>Capability to add additional dependencies to the javadoc classpath. Example: <pre> <additionalDependencies> @@ -1089,8 +1078,8 @@ or <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/AdditionalDependency.html"><code>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></code></a></li> <li><strong>Since</strong>: <code>2.8.1</code></li> -<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="additionalJOption"><section> -<h4><a name="a.3CadditionalJOption.3E"></a><additionalJOption></h4><a name="a.3CadditionalJOption.3E"></a></a> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="additionalJOption"></a><section> +<h4><a name="a.3CadditionalJOption.3E"></a><additionalJOption></h4><a name="a.3CadditionalJOption.3E"></a> <div>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <pre> <additionalJOption>-J-Xss128m</additionalJOption> @@ -1099,8 +1088,8 @@ or <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>2.3</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>additionalJOption</code></li></ul><hr /></section><a name="additionalJOptions"><section> -<h4><a name="a.3CadditionalJOptions.3E"></a><additionalJOptions></h4><a name="a.3CadditionalJOptions.3E"></a></a> +<li><strong>User Property</strong>: <code>additionalJOption</code></li></ul><hr /></section><a name="additionalJOptions"></a><section> +<h4><a name="a.3CadditionalJOptions.3E"></a><additionalJOptions></h4><a name="a.3CadditionalJOptions.3E"></a> <div>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <pre> <additionalJOptions> @@ -1110,36 +1099,36 @@ or <ul> <li><strong>Type</strong>: <code>java.lang.String[]</code></li> <li><strong>Since</strong>: <code>2.9</code></li> -<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="additionalOptions"><section> -<h4><a name="a.3CadditionalOptions.3E"></a><additionalOptions></h4><a name="a.3CadditionalOptions.3E"></a></a> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="additionalOptions"></a><section> +<h4><a name="a.3CadditionalOptions.3E"></a><additionalOptions></h4><a name="a.3CadditionalOptions.3E"></a> <div>Set an additional option(s) on the command line. All input will be passed as-is to the <code>@options</code> file. You must take care of quoting and escaping. Useful for a custom doclet.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String[]</code></li> <li><strong>Since</strong>: <code>3.0.0</code></li> -<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="applyJavadocSecurityFix"><section> -<h4><a name="a.3CapplyJavadocSecurityFix.3E"></a><applyJavadocSecurityFix></h4><a name="a.3CapplyJavadocSecurityFix.3E"></a></a> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="applyJavadocSecurityFix"></a><section> +<h4><a name="a.3CapplyJavadocSecurityFix.3E"></a><applyJavadocSecurityFix></h4><a name="a.3CapplyJavadocSecurityFix.3E"></a> <div>To apply a security fix on generated javadoc, see</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.9.1</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>maven.javadoc.applyJavadocSecurityFix</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="author"><section> -<h4><a name="a.3Cauthor.3E"></a><author></h4><a name="a.3Cauthor.3E"></a></a> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="author"></a><section> +<h4><a name="a.3Cauthor.3E"></a><author></h4><a name="a.3Cauthor.3E"></a> <div>Specifies whether or not the author text is included in the generated Javadocs.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option author</a>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>author</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="bootclasspath"><section> -<h4><a name="a.3Cbootclasspath.3E"></a><bootclasspath></h4><a name="a.3Cbootclasspath.3E"></a></a> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="bootclasspath"></a><section> +<h4><a name="a.3Cbootclasspath.3E"></a><bootclasspath></h4><a name="a.3Cbootclasspath.3E"></a> <div>Specifies the paths where the boot classes reside. The <code>bootclasspath</code> can contain multiple paths by separating them with a colon (<code>:</code>) or a semicolon (<code>;</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path";> Javadoc option bootclasspath</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>2.5</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>bootclasspath</code></li></ul><hr /></section><a name="bootclasspathArtifacts"><section> -<h4><a name="a.3CbootclasspathArtifacts.3E"></a><bootclasspathArtifacts></h4><a name="a.3CbootclasspathArtifacts.3E"></a></a> +<li><strong>User Property</strong>: <code>bootclasspath</code></li></ul><hr /></section><a name="bootclasspathArtifacts"></a><section> +<h4><a name="a.3CbootclasspathArtifacts.3E"></a><bootclasspathArtifacts></h4><a name="a.3CbootclasspathArtifacts.3E"></a> <div>Specifies the artifacts where the boot classes reside. <br /> Example: @@ -1158,8 +1147,8 @@ or <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/BootclasspathArtifact.html"><code>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</code></a></li> <li><strong>Since</strong>: <code>2.5</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>bootclasspathArtifacts</code></li></ul><hr /></section><a name="bottom"><section> -<h4><a name="a.3Cbottom.3E"></a><bottom></h4><a name="a.3Cbottom.3E"></a></a> +<li><strong>User Property</strong>: <code>bootclasspathArtifacts</code></li></ul><hr /></section><a name="bottom"></a><section> +<h4><a name="a.3Cbottom.3E"></a><bottom></h4><a name="a.3Cbottom.3E"></a> <div>Specifies the text to be placed at the bottom of each output file. <br /> If you want to use html, you have to put it in a CDATA section, @@ -1170,21 +1159,21 @@ or <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>bottom</code></li> -<li><strong>Default</strong>: <code>Copyright © {inceptionYear}–{currentYear} {organizationName}. All rights reserved.</code></li></ul><hr /></section><a name="breakiterator"><section> -<h4><a name="a.3Cbreakiterator.3E"></a><breakiterator></h4><a name="a.3Cbreakiterator.3E"></a></a> +<li><strong>Default</strong>: <code>Copyright © {inceptionYear}–{currentYear} {organizationName}. All rights reserved.</code></li></ul><hr /></section><a name="breakiterator"></a><section> +<h4><a name="a.3Cbreakiterator.3E"></a><breakiterator></h4><a name="a.3Cbreakiterator.3E"></a> <div>Uses the sentence break iterator to determine the end of the first sentence.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";> Javadoc option breakiterator</a>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>breakiterator</code></li> -<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="charset"><section> -<h4><a name="a.3Ccharset.3E"></a><charset></h4><a name="a.3Ccharset.3E"></a></a> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="charset"></a><section> +<h4><a name="a.3Ccharset.3E"></a><charset></h4><a name="a.3Ccharset.3E"></a> <div>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the <a href="#docencoding"><code>docencoding</code></a> parameter.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option charset</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>charset</code></li></ul><hr /></section><a name="debug"><section> -<h4><a name="a.3Cdebug.3E"></a><debug></h4><a name="a.3Cdebug.3E"></a></a> +<li><strong>User Property</strong>: <code>charset</code></li></ul><hr /></section><a name="debug"></a><section> +<h4><a name="a.3Cdebug.3E"></a><debug></h4><a name="a.3Cdebug.3E"></a> <div>Set this to <code>true</code> to debug the Javadoc plugin. With this, <code>javadoc.bat(or.sh)</code>, <code>options</code>, <code>@packages</code> or <code>argfile</code> files are provided in the output directory. <br /></div> <ul> @@ -1192,8 +1181,8 @@ or <li><strong>Since</strong>: <code>2.1</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>debug</code></li> -<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="dependencyLinks"><section> -<h4><a name="a.3CdependencyLinks.3E"></a><dependencyLinks></h4><a name="a.3CdependencyLinks.3E"></a></a> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="dependencyLinks"></a><section> +<h4><a name="a.3CdependencyLinks.3E"></a><dependencyLinks></h4><a name="a.3CdependencyLinks.3E"></a> <div>Redefine the apidoc URL for specific dependencies when using <a href="#detectLinks"><code>detectLinks</code></a>. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <pre> <dependencyLinks> @@ -1208,36 +1197,27 @@ or <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/DependencyLink.html"><code>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></code></a></li> <li><strong>Since</strong>: <code>3.3.0</code></li> -<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="dependencySourceExcludes"><section> -<h4><a name="a.3CdependencySourceExcludes.3E"></a><dependencySourceExcludes></h4><a name="a.3CdependencySourceExcludes.3E"></a></a> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="dependencySourceExcludes"></a><section> +<h4><a name="a.3CdependencySourceExcludes.3E"></a><dependencySourceExcludes></h4><a name="a.3CdependencySourceExcludes.3E"></a> <div>List of excluded dependency-source patterns. Example: <code>org.apache.maven.shared:*</code><br /><strong>See also:</strong> <a href="#includeDependencySources">includeDependencySources</a></div> <ul> <li><strong>Type</strong>: <code>java.util.List<java.lang.String></code></li> <li><strong>Since</strong>: <code>2.7</code></li> -<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="dependencySourceIncludes"><section> -<h4><a name="a.3CdependencySourceIncludes.3E"></a><dependencySourceIncludes></h4><a name="a.3CdependencySourceIncludes.3E"></a></a> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="dependencySourceIncludes"></a><section> +<h4><a name="a.3CdependencySourceIncludes.3E"></a><dependencySourceIncludes></h4><a name="a.3CdependencySourceIncludes.3E"></a> <div>List of included dependency-source patterns. Example: <code>org.apache.maven:*</code><br /><strong>See also:</strong> <a href="#includeDependencySources">includeDependencySources</a></div> <ul> <li><strong>Type</strong>: <code>java.util.List<java.lang.String></code></li> <li><strong>Since</strong>: <code>2.7</code></li> -<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="description"><section> -<h4><a name="a.3Cdescription.3E"></a><description></h4><a name="a.3Cdescription.3E"></a></a> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="description"></a><section> +<h4><a name="a.3Cdescription.3E"></a><description></h4><a name="a.3Cdescription.3E"></a> <div>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. <code>project-reports.html</code>).</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>2.1</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>description</code></li></ul><hr /></section><a name="destDir"><section> -<h4><a name="a.3CdestDir.3E"></a><destDir></h4><a name="a.3CdestDir.3E"></a></a> -<div>The name of the destination directory. -<br /></div> -<ul> -<li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Since</strong>: <code>2.1</code></li> -<li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>destDir</code></li> -<li><strong>Default</strong>: <code>apidocs</code></li></ul><hr /></section><a name="detectJavaApiLink"><section> -<h4><a name="a.3CdetectJavaApiLink.3E"></a><detectJavaApiLink></h4><a name="a.3CdetectJavaApiLink.3E"></a></a> +<li><strong>User Property</strong>: <code>description</code></li></ul><hr /></section><a name="detectJavaApiLink"></a><section> +<h4><a name="a.3CdetectJavaApiLink.3E"></a><detectJavaApiLink></h4><a name="a.3CdetectJavaApiLink.3E"></a> <div>Detect the Java API link for the current build, e.g. <code>https://docs.oracle.com/javase/1.4.2/docs/api/</code> for Java source 1.4. <br /> By default, the goal detects the Javadoc API link depending the value of the <code>source</code> parameter in the <code>org.apache.maven.plugins:maven-compiler-plugin</code> (defined in <code>${project.build.plugins}</code> or in <code>${project.build.pluginManagement}</code>), or try to compute it from the <code>javadocExecutable</code> version.<br /><strong>See also:</strong> <a href="#links">links</a>, <a href="#javaApiLinks">javaApiLinks</a></div> @@ -1246,8 +1226,8 @@ or <li><strong>Since</strong>: <code>2.6</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>detectJavaApiLink</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="detectLinks"><section> -<h4><a name="a.3CdetectLinks.3E"></a><detectLinks></h4><a name="a.3CdetectLinks.3E"></a></a> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="detectLinks"></a><section> +<h4><a name="a.3CdetectLinks.3E"></a><detectLinks></h4><a name="a.3CdetectLinks.3E"></a> <div>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: <code>${project.url}/apidocs</code>. <br /> For instance, if the project has a dependency to <a href="http://commons.apache.org/lang/";>Apache Commons Lang</a> i.e.: @@ -1262,8 +1242,8 @@ or <li><strong>Since</strong>: <code>2.6</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>detectLinks</code></li> -<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="detectOfflineLinks"><section> -<h4><a name="a.3CdetectOfflineLinks.3E"></a><detectOfflineLinks></h4><a name="a.3CdetectOfflineLinks.3E"></a></a> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="detectOfflineLinks"></a><section> +<h4><a name="a.3CdetectOfflineLinks.3E"></a><detectOfflineLinks></h4><a name="a.3CdetectOfflineLinks.3E"></a> <div>Detect the links for all modules defined in the project. <br /> If <code>reactorProjects</code> 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 <code>module1</code> and <code>module2</code>, the <code>-linkoffline</code> will be: @@ -1276,28 +1256,28 @@ or <li><strong>Since</strong>: <code>2.6</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>detectOfflineLinks</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="docencoding"><section> -<h4><a name="a.3Cdocencoding.3E"></a><docencoding></h4><a name="a.3Cdocencoding.3E"></a></a> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="docencoding"></a><section> +<h4><a name="a.3Cdocencoding.3E"></a><docencoding></h4><a name="a.3Cdocencoding.3E"></a> <div>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be <code>UTF-8</code>.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option docencoding</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>docencoding</code></li> -<li><strong>Default</strong>: <code>${project.reporting.outputEncoding}</code></li></ul><hr /></section><a name="docfilessubdirs"><section> -<h4><a name="a.3Cdocfilessubdirs.3E"></a><docfilessubdirs></h4><a name="a.3Cdocfilessubdirs.3E"></a></a> +<li><strong>Default</strong>: <code>${project.reporting.outputEncoding}</code></li></ul><hr /></section><a name="docfilessubdirs"></a><section> +<h4><a name="a.3Cdocfilessubdirs.3E"></a><docfilessubdirs></h4><a name="a.3Cdocfilessubdirs.3E"></a> <div>Enables deep copying of the <code>**/doc-files</code> directories and the specifc <code>resources</code> directory from the <code>javadocDirectory</code> directory (for instance, <code>src/main/javadoc/com/mycompany/myapp/doc-files</code> and <code>src/main/javadoc/resources</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option docfilessubdirs</a>., <a href="#excludedocfilessubdir">excludedocfilessubdir</a>, <a href="#javadocDirectory">javadocDirectory</a></div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>docfilessubdirs</code></li> -<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="doclet"><section> -<h4><a name="a.3Cdoclet.3E"></a><doclet></h4><a name="a.3Cdoclet.3E"></a></a> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="doclet"></a><section> +<h4><a name="a.3Cdoclet.3E"></a><doclet></h4><a name="a.3Cdoclet.3E"></a> <div>Specifies the class file that starts the doclet used in generating the documentation.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option doclet</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>doclet</code></li></ul><hr /></section><a name="docletArtifact"><section> -<h4><a name="a.3CdocletArtifact.3E"></a><docletArtifact></h4><a name="a.3CdocletArtifact.3E"></a></a> +<li><strong>User Property</strong>: <code>doclet</code></li></ul><hr /></section><a name="docletArtifact"></a><section> +<h4><a name="a.3CdocletArtifact.3E"></a><docletArtifact></h4><a name="a.3CdocletArtifact.3E"></a> <div>Specifies the artifact containing the doclet starting class file (specified with the <a href="#doclet"><code>doclet</code></a> option). <br /> Example: @@ -1314,8 +1294,8 @@ or <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/DocletArtifact.html"><code>org.apache.maven.plugins.javadoc.options.DocletArtifact</code></a></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>docletArtifact</code></li></ul><hr /></section><a name="docletArtifacts"><section> -<h4><a name="a.3CdocletArtifacts.3E"></a><docletArtifacts></h4><a name="a.3CdocletArtifacts.3E"></a></a> +<li><strong>User Property</strong>: <code>docletArtifact</code></li></ul><hr /></section><a name="docletArtifacts"></a><section> +<h4><a name="a.3CdocletArtifacts.3E"></a><docletArtifacts></h4><a name="a.3CdocletArtifacts.3E"></a> <div>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the <a href="#doclet"><code>doclet</code></a> option). <br /> Example: @@ -1335,36 +1315,36 @@ or <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/DocletArtifact.html"><code>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</code></a></li> <li><strong>Since</strong>: <code>2.1</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>docletArtifacts</code></li></ul><hr /></section><a name="docletPath"><section> -<h4><a name="a.3CdocletPath.3E"></a><docletPath></h4><a name="a.3CdocletPath.3E"></a></a> +<li><strong>User Property</strong>: <code>docletArtifacts</code></li></ul><hr /></section><a name="docletPath"></a><section> +<h4><a name="a.3CdocletPath.3E"></a><docletPath></h4><a name="a.3CdocletPath.3E"></a> <div>Specifies the path to the doclet starting class file (specified with the <a href="#doclet"><code>doclet</code></a> option) and any jar files it depends on. The <code>docletPath</code> can contain multiple paths by separating them with a colon (<code>:</code>) or a semicolon (<code>;</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc";>Javadoc option docletpath</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>docletPath</code></li></ul><hr /></section><a name="doclint"><section> -<h4><a name="a.3Cdoclint.3E"></a><doclint></h4><a name="a.3Cdoclint.3E"></a></a> +<li><strong>User Property</strong>: <code>docletPath</code></li></ul><hr /></section><a name="doclint"></a><section> +<h4><a name="a.3Cdoclint.3E"></a><doclint></h4><a name="a.3Cdoclint.3E"></a> <div>Specifies specific checks to be performed on Javadoc comments.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet";>Additional Doclet option Xdoclint</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>3.0.0</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>doclint</code></li></ul><hr /></section><a name="doctitle"><section> -<h4><a name="a.3Cdoctitle.3E"></a><doctitle></h4><a name="a.3Cdoctitle.3E"></a></a> +<li><strong>User Property</strong>: <code>doclint</code></li></ul><hr /></section><a name="doctitle"></a><section> +<h4><a name="a.3Cdoctitle.3E"></a><doctitle></h4><a name="a.3Cdoctitle.3E"></a> <div>Specifies the title to be placed near the top of the overview summary file.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option doctitle</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>doctitle</code></li> -<li><strong>Default</strong>: <code>${project.name} ${project.version} API</code></li></ul><hr /></section><a name="encoding"><section> -<h4><a name="a.3Cencoding.3E"></a><encoding></h4><a name="a.3Cencoding.3E"></a></a> +<li><strong>Default</strong>: <code>${project.name} ${project.version} API</code></li></ul><hr /></section><a name="encoding"></a><section> +<h4><a name="a.3Cencoding.3E"></a><encoding></h4><a name="a.3Cencoding.3E"></a> <div>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the <code>file.encoding</code> system property. <br /><b>Note</b>: In 2.4, the default value was locked to <code>ISO-8859-1</code> to ensure reproducing build, but this was reverted in 2.5.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding";>Javadoc option encoding</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>encoding</code></li> -<li><strong>Default</strong>: <code>${project.build.sourceEncoding}</code></li></ul><hr /></section><a name="excludePackageNames"><section> -<h4><a name="a.3CexcludePackageNames.3E"></a><excludePackageNames></h4><a name="a.3CexcludePackageNames.3E"></a></a> +<li><strong>Default</strong>: <code>${project.build.sourceEncoding}</code></li></ul><hr /></section><a name="excludePackageNames"></a><section> +<h4><a name="a.3CexcludePackageNames.3E"></a><excludePackageNames></h4><a name="a.3CexcludePackageNames.3E"></a> <div>Unconditionally excludes the specified packages and their subpackages from the list formed by <code>-subpackages</code>. Multiple packages can be separated by commas (<code>,</code>), colons (<code>:</code>) or semicolons (<code>;</code>). <p>Wildcards work as followed:</p> <ul> @@ -1378,50 +1358,50 @@ or <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>excludePackageNames</code></li></ul><hr /></section><a name="excludedocfilessubdir"><section> -<h4><a name="a.3Cexcludedocfilessubdir.3E"></a><excludedocfilessubdir></h4><a name="a.3Cexcludedocfilessubdir.3E"></a></a> +<li><strong>User Property</strong>: <code>excludePackageNames</code></li></ul><hr /></section><a name="excludedocfilessubdir"></a><section> +<h4><a name="a.3Cexcludedocfilessubdir.3E"></a><excludedocfilessubdir></h4><a name="a.3Cexcludedocfilessubdir.3E"></a> <div>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (<code>:</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option excludedocfilessubdir</a>., <a href="#docfilessubdirs">docfilessubdirs</a></div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>excludedocfilessubdir</code></li></ul><hr /></section><a name="extdirs"><section> -<h4><a name="a.3Cextdirs.3E"></a><extdirs></h4><a name="a.3Cextdirs.3E"></a></a> +<li><strong>User Property</strong>: <code>excludedocfilessubdir</code></li></ul><hr /></section><a name="extdirs"></a><section> +<h4><a name="a.3Cextdirs.3E"></a><extdirs></h4><a name="a.3Cextdirs.3E"></a> <div>Specifies the directories where extension classes reside. Separate directories in <code>extdirs</code> with a colon (<code>:</code>) or a semicolon (<code>;</code>).<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs";>Javadoc option extdirs</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>extdirs</code></li></ul><hr /></section><a name="failOnError"><section> -<h4><a name="a.3CfailOnError.3E"></a><failOnError></h4><a name="a.3CfailOnError.3E"></a></a> +<li><strong>User Property</strong>: <code>extdirs</code></li></ul><hr /></section><a name="failOnError"></a><section> +<h4><a name="a.3CfailOnError.3E"></a><failOnError></h4><a name="a.3CfailOnError.3E"></a> <div>Specifies if the build will fail if there are errors during javadoc execution or not.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.5</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>maven.javadoc.failOnError</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="failOnWarnings"><section> -<h4><a name="a.3CfailOnWarnings.3E"></a><failOnWarnings></h4><a name="a.3CfailOnWarnings.3E"></a></a> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="failOnWarnings"></a><section> +<h4><a name="a.3CfailOnWarnings.3E"></a><failOnWarnings></h4><a name="a.3CfailOnWarnings.3E"></a> <div>Specifies if the build will fail if there are warning during javadoc execution or not.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>3.0.1</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>maven.javadoc.failOnWarnings</code></li> -<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="footer"><section> -<h4><a name="a.3Cfooter.3E"></a><footer></h4><a name="a.3Cfooter.3E"></a></a> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="footer"></a><section> +<h4><a name="a.3Cfooter.3E"></a><footer></h4><a name="a.3Cfooter.3E"></a> <div>Specifies the footer text to be placed at the bottom of each output file.<br /><strong>See also:</strong> <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";>Doclet option footer</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>footer</code></li></ul><hr /></section><a name="forceRootLocale"><section> -<h4><a name="a.3CforceRootLocale.3E"></a><forceRootLocale></h4><a name="a.3CforceRootLocale.3E"></a></a> +<li><strong>User Property</strong>: <code>footer</code></li></ul><hr /></section><a name="forceRootLocale"></a><section> +<h4><a name="a.3CforceRootLocale.3E"></a><forceRootLocale></h4><a name="a.3CforceRootLocale.3E"></a> <div>Forces the Javadoc JVM locale to be <code>java.util.Locale.ROOT</code><!-- reference not found in associated javadoc sites -->. This will force the Javadoc output on <code>stdout</code> and <code>stderr</code> 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 <a href="#locale"><code>locale</code></a>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>3.8.0</code></li> <li><strong>Required</strong>: <code>No</code></li>
[... 680 lines stripped ...]
