Modified: maven/website/components/plugins-archives/maven-javadoc-plugin-LATEST/aggregate-jar-mojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-javadoc-plugin-LATEST/aggregate-jar-mojo.html (original) +++ maven/website/components/plugins-archives/maven-javadoc-plugin-LATEST/aggregate-jar-mojo.html Wed May 29 16:20:04 2024 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.10.2:report at 2023-11-30 + | 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-05-29 | Rendered using Apache Maven Fluido Skin 1.11.2 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> @@ -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-jar</li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-11-30</li> - <li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 3.6.3</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-29</li> + <li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 3.7.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> @@ -132,7 +132,7 @@ <section> <h2><a name="javadoc:aggregate-jar"></a>javadoc:aggregate-jar</h2><a name="javadoc:aggregate-jar"></a> <p><strong>Full name</strong>:</p> -<p>org.apache.maven.plugins:maven-javadoc-plugin:3.6.3:aggregate-jar</p> +<p>org.apache.maven.plugins:maven-javadoc-plugin:3.7.0:aggregate-jar</p> <p><strong>Description</strong>:</p> <p><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></p> @@ -170,6 +170,16 @@ <th>Since</th> <th>Description</th></tr> <tr class="b"> +<td align="left"><a href="#addStylesheets"><code><addStylesheets></code></a></td> +<td><code>String[]</code></td> +<td><code>3.3.0</code></td> +<td>Specifies the path of an additional HTML stylesheet file relative to the <code>javadocDirectory</code> Example: +<pre> + <addStylesheets> + <addStylesheet>resources/addstylesheet.css</addStylesheet> + </addStylesheets> +</pre></td></tr> +<tr class="a"> <td align="left"><a href="#additionalDependencies"><code><additionalDependencies></code></a></td> <td><a href="apidocs/org/apache/maven/plugins/javadoc/AdditionalDependency.html"><code>List<AdditionalDependency></code></a></td> <td><code>2.8.1</code></td> @@ -183,7 +193,7 @@ </additionalDependency> </additionalDependencies> </pre></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#additionalJOption"><code><additionalJOption></code></a></td> <td><code>String</code></td> <td><code>2.3</code></td> @@ -191,7 +201,7 @@ <pre> <additionalJOption>-J-Xss128m</additionalJOption> </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 Options</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options";> VM Options</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html";> Networking Properties</a><br /><strong>User Property</strong>: <code>additionalJOption</code></td></tr> -<tr class="b"> +<tr class="a"> <td align="left"><a href="#additionalJOptions"><code><additionalJOptions></code></a></td> <td><code>String[]</code></td> <td><code>2.9</code></td> @@ -201,21 +211,11 @@ <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions> </pre><br /><strong>See also:</strong> <a href="#additionalJOption">additionalJOption</a></td></tr> -<tr class="a"> +<tr class="b"> <td align="left"><a href="#additionalOptions"><code><additionalOptions></code></a></td> <td><code>String[]</code></td> <td><code>3.0.0</code></td> <td>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.</td></tr> -<tr class="b"> -<td align="left"><a href="#addStylesheets"><code><addStylesheets></code></a></td> -<td><code>String[]</code></td> -<td><code>3.3.0</code></td> -<td>Specifies the path of an additional HTML stylesheet file relative to the <code>javadocDirectory</code> Example: -<pre> - <addStylesheets> - <resources/addstylesheet.css</addStylesheet> - </addStylesheets> -</pre></td></tr> <tr class="a"> <td align="left"><a href="#applyJavadocSecurityFix"><code><applyJavadocSecurityFix></code></a></td> <td><code>boolean</code></td> @@ -315,7 +315,8 @@ <td align="left"><a href="#destDir"><code><destDir></code></a></td> <td><code>File</code></td> <td><code>-</code></td> -<td><strong>Deprecated.</strong> 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#standard-doclet-options";>Doclet option d</a>.<br /><strong>User Property</strong>: <code>destDir</code></td></tr> +<td> +<div><strong>Deprecated.</strong><br />No reason given</div><br />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#standard-doclet-options";>Doclet option d</a>.<br /><strong>User Property</strong>: <code>destDir</code></td></tr> <tr class="a"> <td align="left"><a href="#detectJavaApiLink"><code><detectJavaApiLink></code></a></td> <td><code>boolean</code></td> @@ -420,11 +421,6 @@ <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="a"> -<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"> <td align="left"><a href="#excludePackageNames"><code><excludePackageNames></code></a></td> <td><code>String</code></td> <td><code>-</code></td> @@ -438,6 +434,11 @@ <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="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="a"> <td align="left"><a href="#extdirs"><code><extdirs></code></a></td> <td><code>String</code></td> @@ -481,7 +482,7 @@ </group> <group> <title>Extension Packages</title> - <!-- To include javax.accessibility, +  <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> @@ -536,7 +537,8 @@ <td align="left"><a href="#includeTransitiveDependencySources"><code><includeTransitiveDependencySources></code></a></td> <td><code>boolean</code></td> <td><code>2.7</code></td> -<td><strong>Deprecated.</strong> 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> +<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="a"> <td align="left"><a href="#jarOutputDirectory"><code><jarOutputDirectory></code></a></td> <td><code>String</code></td> @@ -753,7 +755,8 @@ or <td align="left"><a href="#old"><code><old></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> -<td><strong>Deprecated.</strong> 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> +<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="b"> <td align="left"><a href="#outputTimestamp"><code><outputTimestamp></code></a></td> <td><code>String</code></td> @@ -875,7 +878,8 @@ or <td align="left"><a href="#stylesheet"><code><stylesheet></code></a></td> <td><code>String</code></td> <td><code>-</code></td> -<td><strong>Deprecated.</strong> 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. +<td> +<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="a"> @@ -1073,7 +1077,18 @@ or <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="additionalDependencies"><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> +<div>Specifies the path of an additional HTML stylesheet file relative to the <code>javadocDirectory</code> Example: +<pre> + <addStylesheets> + <addStylesheet>resources/addstylesheet.css</addStylesheet> + </addStylesheets> +</pre></div> +<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> <div>Capability to add additional dependencies to the javadoc classpath. Example: <pre> @@ -1088,7 +1103,7 @@ 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>report.plugin.goal.no</code></li></ul><hr /></section><a name="additionalJOption"><section> +<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> <div>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <pre> @@ -1097,7 +1112,7 @@ or <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>2.3</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</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> <div>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: @@ -1109,30 +1124,19 @@ 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>report.plugin.goal.no</code></li></ul><hr /></section><a name="additionalOptions"><section> +<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> <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>report.plugin.goal.no</code></li></ul><hr /></section><a name="addStylesheets"><section> -<h4><a name="a.3CaddStylesheets.3E"></a><addStylesheets></h4><a name="a.3CaddStylesheets.3E"></a></a> -<div>Specifies the path of an additional HTML stylesheet file relative to the <code>javadocDirectory</code> Example: -<pre> - <addStylesheets> - <resources/addstylesheet.css</addStylesheet> - </addStylesheets> -</pre></div> -<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>report.plugin.goal.no</code></li></ul><hr /></section><a name="applyJavadocSecurityFix"><section> +<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> <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>report.plugin.goal.no</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="archive"><section> <h4><a name="a.3Carchive.3E"></a><archive></h4><a name="a.3Carchive.3E"></a></a> @@ -1140,20 +1144,20 @@ or <ul> <li><strong>Type</strong>: <code>org.apache.maven.archiver.MavenArchiveConfiguration</code></li> <li><strong>Since</strong>: <code>2.5</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li></ul><hr /></section><a name="attach"><section> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="attach"><section> <h4><a name="a.3Cattach.3E"></a><attach></h4><a name="a.3Cattach.3E"></a></a> <div>Specifies whether to attach the generated artifact to the project helper. <br /></div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>attach</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> <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>report.plugin.goal.no</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> @@ -1161,7 +1165,7 @@ or <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>report.plugin.goal.no</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> <div>Specifies the artifacts where the boot classes reside. @@ -1181,7 +1185,7 @@ or <ul> <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>report.plugin.goal.no</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> <div>Specifies the text to be placed at the bottom of each output file. @@ -1192,28 +1196,28 @@ or <br /><strong>Note:<strong>If the project has the property <code>project.build.outputTimestamp</code>, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.</strong></strong><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 bottom</a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</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> <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>report.plugin.goal.no</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> <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>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>charset</code></li></ul><hr /></section><a name="classifier"><section> <h4><a name="a.3Cclassifier.3E"></a><classifier></h4><a name="a.3Cclassifier.3E"></a></a> <div>No description.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>2.10</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.yes</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> <li><strong>User Property</strong>: <code>maven.javadoc.classifier</code></li> <li><strong>Default</strong>: <code>javadoc</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> @@ -1222,7 +1226,7 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.1</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</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> @@ -1240,25 +1244,25 @@ 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>report.plugin.goal.no</code></li></ul><hr /></section><a name="dependencySourceExcludes"><section> +<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> <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>report.plugin.goal.no</code></li></ul><hr /></section><a name="dependencySourceIncludes"><section> +<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> <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>report.plugin.goal.no</code></li></ul><hr /></section><a name="destDir"><section> +<li><strong>Required</strong>: <code>No</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><strong>Deprecated.</strong> No reason given</div> +<div><strong>Deprecated.</strong><br />No reason given</div><br /> <div>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#standard-doclet-options";>Doclet option d</a>.</div> <ul> <li><strong>Type</strong>: <code>java.io.File</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>destDir</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> <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. @@ -1267,7 +1271,7 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.6</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</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> @@ -1283,7 +1287,7 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.6</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</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> @@ -1297,28 +1301,28 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.6</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</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> <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>report.plugin.goal.no</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> <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>report.plugin.goal.no</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> <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>report.plugin.goal.no</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> <div>Specifies the artifact containing the doclet starting class file (specified with the <a href="#doclet"><code>doclet</code></a> option). @@ -1336,7 +1340,7 @@ or <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>.</div> <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>report.plugin.goal.no</code></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> <div>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the <a href="#doclet"><code>doclet</code></a> option). @@ -1357,26 +1361,26 @@ 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>Since</strong>: <code>2.1</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</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> <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>report.plugin.goal.no</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> <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>report.plugin.goal.no</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> <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>report.plugin.goal.no</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> @@ -1384,15 +1388,9 @@ or <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>report.plugin.goal.no</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="excludedocfilessubdir"><section> -<h4><a name="a.3Cexcludedocfilessubdir.3E"></a><excludedocfilessubdir></h4><a name="a.3Cexcludedocfilessubdir.3E"></a></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>report.plugin.goal.no</code></li> -<li><strong>User Property</strong>: <code>excludedocfilessubdir</code></li></ul><hr /></section><a name="excludePackageNames"><section> +<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> <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> @@ -1406,20 +1404,26 @@ or </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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> -<li><strong>User Property</strong>: <code>excludePackageNames</code></li></ul><hr /></section><a name="extdirs"><section> +<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> +<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> <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>report.plugin.goal.no</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> <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>report.plugin.goal.no</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> @@ -1427,20 +1431,20 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>3.0.1</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</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="finalName"><section> <h4><a name="a.3CfinalName.3E"></a><finalName></h4><a name="a.3CfinalName.3E"></a></a> <div>Specifies the filename that will be used for the generated jar file. Please note that <code>-javadoc</code> or <code>-test-javadoc</code> will be appended to the file name.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>project.build.finalName</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> <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>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>footer</code></li></ul><hr /></section><a name="groups"><section> <h4><a name="a.3Cgroups.3E"></a><groups></h4><a name="a.3Cgroups.3E"></a></a> <div>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 (<code>*</code>) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (<code>:</code>). @@ -1457,7 +1461,7 @@ or </group> <group> <title>Extension Packages</title> - <!-- To include javax.accessibility, +  <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> @@ -1465,12 +1469,12 @@ or </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></div> <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/Group.html"><code>org.apache.maven.plugins.javadoc.options.Group[]</code></a></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li></ul><hr /></section><a name="header"><section> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="header"><section> <h4><a name="a.3Cheader.3E"></a><header></h4><a name="a.3Cheader.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>header</code></li></ul><hr /></section><a name="helpfile"><section> <h4><a name="a.3Chelpfile.3E"></a><helpfile></h4><a name="a.3Chelpfile.3E"></a></a> <div>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to. @@ -1506,28 +1510,28 @@ or </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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>helpfile</code></li></ul><hr /></section><a name="includeDependencySources"><section> <h4><a name="a.3CincludeDependencySources.3E"></a><includeDependencySources></h4><a name="a.3CincludeDependencySources.3E"></a></a> <div>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.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.7</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="includeTransitiveDependencySources"><section> <h4><a name="a.3CincludeTransitiveDependencySources.3E"></a><includeTransitiveDependencySources></h4><a name="a.3CincludeTransitiveDependencySources.3E"></a></a> -<div><strong>Deprecated.</strong> if these sources depend on transitive dependencies, those dependencies should be added to the pom as direct dependencies</div> +<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 /> <div>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></div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.7</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="jarOutputDirectory"><section> <h4><a name="a.3CjarOutputDirectory.3E"></a><jarOutputDirectory></h4><a name="a.3CjarOutputDirectory.3E"></a></a> <div>Specifies the directory where the generated jar file will be put.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>project.build.directory</code></li></ul><hr /></section><a name="javaApiLinks"><section> <h4><a name="a.3CjavaApiLinks.3E"></a><javaApiLinks></h4><a name="a.3CjavaApiLinks.3E"></a></a> <div>Use this parameter <b>only</b> if if you want to override the default URLs. The key should match <code>api_x</code>, where <code>x</code> matches the Java version. For example: @@ -1556,7 +1560,7 @@ or <ul> <li><strong>Type</strong>: <code>java.util.Properties</code></li> <li><strong>Since</strong>: <code>2.6</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>javaApiLinks</code></li></ul><hr /></section><a name="javadocDirectory"><section> <h4><a name="a.3CjavadocDirectory.3E"></a><javadocDirectory></h4><a name="a.3CjavadocDirectory.3E"></a></a> <div>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...). @@ -1567,21 +1571,21 @@ or <ul> <li><strong>Type</strong>: <code>java.io.File</code></li> <li><strong>Since</strong>: <code>2.1</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>Default</strong>: <code>${basedir}/src/main/javadoc</code></li></ul><hr /></section><a name="javadocExecutable"><section> <h4><a name="a.3CjavadocExecutable.3E"></a><javadocExecutable></h4><a name="a.3CjavadocExecutable.3E"></a></a> <div>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.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>2.3</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>javadocExecutable</code></li></ul><hr /></section><a name="javadocVersion"><section> <h4><a name="a.3CjavadocVersion.3E"></a><javadocVersion></h4><a name="a.3CjavadocVersion.3E"></a></a> <div>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>2.3</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>javadocVersion</code></li></ul><hr /></section><a name="jdkToolchain"><section> <h4><a name="a.3CjdkToolchain.3E"></a><jdkToolchain></h4><a name="a.3CjdkToolchain.3E"></a></a> <div><p>Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.</p> @@ -1607,13 +1611,13 @@ or <ul> <li><strong>Type</strong>: <code>java.util.Map<java.lang.String, java.lang.String></code></li> <li><strong>Since</strong>: <code>3.0.0</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li></ul><hr /></section><a name="keywords"><section> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="keywords"><section> <h4><a name="a.3Ckeywords.3E"></a><keywords></h4><a name="a.3Ckeywords.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.1</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>keywords</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="legacyMode"><section> <h4><a name="a.3ClegacyMode.3E"></a><legacyMode></h4><a name="a.3ClegacyMode.3E"></a></a> @@ -1621,7 +1625,7 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>3.6.0</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>legacyMode</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="links"><section> <h4><a name="a.3Clinks.3E"></a><links></h4><a name="a.3Clinks.3E"></a></a> @@ -1640,38 +1644,38 @@ or </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></div> <ul> <li><strong>Type</strong>: <code>java.util.ArrayList<java.lang.String></code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>links</code></li></ul><hr /></section><a name="linksource"><section> <h4><a name="a.3Clinksource.3E"></a><linksource></h4><a name="a.3Clinksource.3E"></a></a> <div>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></div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>linksource</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="locale"><section> <h4><a name="a.3Clocale.3E"></a><locale></h4><a name="a.3Clocale.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>locale</code></li></ul><hr /></section><a name="maxmemory"><section> <h4><a name="a.3Cmaxmemory.3E"></a><maxmemory></h4><a name="a.3Cmaxmemory.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>maxmemory</code></li></ul><hr /></section><a name="minmemory"><section> <h4><a name="a.3Cminmemory.3E"></a><minmemory></h4><a name="a.3Cminmemory.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>minmemory</code></li></ul><hr /></section><a name="nocomment"><section> <h4><a name="a.3Cnocomment.3E"></a><nocomment></h4><a name="a.3Cnocomment.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>nocomment</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="nodeprecated"><section> <h4><a name="a.3Cnodeprecated.3E"></a><nodeprecated></h4><a name="a.3Cnodeprecated.3E"></a></a> @@ -1679,14 +1683,14 @@ or <br /></div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>nodeprecated</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="nodeprecatedlist"><section> <h4><a name="a.3Cnodeprecatedlist.3E"></a><nodeprecatedlist></h4><a name="a.3Cnodeprecatedlist.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>nodeprecatedlist</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="nohelp"><section> <h4><a name="a.3Cnohelp.3E"></a><nohelp></h4><a name="a.3Cnohelp.3E"></a></a> @@ -1694,7 +1698,7 @@ or <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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>nohelp</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="noindex"><section> <h4><a name="a.3Cnoindex.3E"></a><noindex></h4><a name="a.3Cnoindex.3E"></a></a> @@ -1702,14 +1706,14 @@ or <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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>noindex</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="nonavbar"><section> <h4><a name="a.3Cnonavbar.3E"></a><nonavbar></h4><a name="a.3Cnonavbar.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>nonavbar</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="nooverview"><section> <h4><a name="a.3Cnooverview.3E"></a><nooverview></h4><a name="a.3Cnooverview.3E"></a></a> @@ -1721,7 +1725,7 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.4</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>nooverview</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="noqualifier"><section> <h4><a name="a.3Cnoqualifier.3E"></a><noqualifier></h4><a name="a.3Cnoqualifier.3E"></a></a> @@ -1733,13 +1737,13 @@ or </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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>noqualifier</code></li></ul><hr /></section><a name="nosince"><section> <h4><a name="a.3Cnosince.3E"></a><nosince></h4><a name="a.3Cnosince.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>nosince</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="notimestamp"><section> <h4><a name="a.3Cnotimestamp.3E"></a><notimestamp></h4><a name="a.3Cnotimestamp.3E"></a></a> @@ -1749,14 +1753,14 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.1</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>notimestamp</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="notree"><section> <h4><a name="a.3Cnotree.3E"></a><notree></h4><a name="a.3Cnotree.3E"></a></a> <div>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></div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>notree</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="offline"><section> <h4><a name="a.3Coffline.3E"></a><offline></h4><a name="a.3Coffline.3E"></a></a> @@ -1764,7 +1768,7 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>3.6.0</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>maven.javadoc.offline</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="offlineLinks"><section> <h4><a name="a.3CofflineLinks.3E"></a><offlineLinks></h4><a name="a.3CofflineLinks.3E"></a></a> @@ -1782,21 +1786,21 @@ or <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></div> <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/OfflineLink.html"><code>org.apache.maven.plugins.javadoc.options.OfflineLink[]</code></a></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>offlineLinks</code></li></ul><hr /></section><a name="old"><section> <h4><a name="a.3Cold.3E"></a><old></h4><a name="a.3Cold.3E"></a></a> -<div><strong>Deprecated.</strong> No reason given</div> +<div><strong>Deprecated.</strong><br />No reason given</div><br /> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>old</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="outputDirectory"><section> <h4><a name="a.3CoutputDirectory.3E"></a><outputDirectory></h4><a name="a.3CoutputDirectory.3E"></a></a> <div>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></div> <ul> <li><strong>Type</strong>: <code>java.io.File</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.yes</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> <li><strong>User Property</strong>: <code>destDir</code></li> <li><strong>Default</strong>: <code>${project.build.directory}/apidocs</code></li> <li><strong>Alias</strong>: <code>destDir</code></li></ul><hr /></section><a name="outputTimestamp"><section> @@ -1805,7 +1809,7 @@ or <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>Default</strong>: <code>${project.build.outputTimestamp}</code></li></ul><hr /></section><a name="overview"><section> <h4><a name="a.3Coverview.3E"></a><overview></h4><a name="a.3Coverview.3E"></a></a> <div>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). @@ -1813,7 +1817,7 @@ or <br /></div> <ul> <li><strong>Type</strong>: <code>java.io.File</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>overview</code></li> <li><strong>Default</strong>: <code>${basedir}/src/main/javadoc/overview.html</code></li></ul><hr /></section><a name="packagesheader"><section> <h4><a name="a.3Cpackagesheader.3E"></a><packagesheader></h4><a name="a.3Cpackagesheader.3E"></a></a> @@ -1821,7 +1825,7 @@ or <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>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>packagesheader</code></li></ul><hr /></section><a name="quiet"><section> <h4><a name="a.3Cquiet.3E"></a><quiet></h4><a name="a.3Cquiet.3E"></a></a> <div>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view. @@ -1831,7 +1835,7 @@ or 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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>quiet</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="release"><section> <h4><a name="a.3Crelease.3E"></a><release></h4><a name="a.3Crelease.3E"></a></a> @@ -1839,7 +1843,7 @@ or <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>JDK 9</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>Default</strong>: <code>${maven.compiler.release}</code></li></ul><hr /></section><a name="resourcesArtifacts"><section> <h4><a name="a.3CresourcesArtifacts.3E"></a><resourcesArtifacts></h4><a name="a.3CresourcesArtifacts.3E"></a></a> <div>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.). @@ -1860,13 +1864,13 @@ or <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/ResourcesArtifact.html"><code>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</code></a></li> <li><strong>Since</strong>: <code>2.5</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>resourcesArtifacts</code></li></ul><hr /></section><a name="serialwarn"><section> <h4><a name="a.3Cserialwarn.3E"></a><serialwarn></h4><a name="a.3Cserialwarn.3E"></a></a> <div>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></div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>serialwarn</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="show"><section> <h4><a name="a.3Cshow.3E"></a><show></h4><a name="a.3Cshow.3E"></a></a> @@ -1879,7 +1883,7 @@ or </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></div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>show</code></li> <li><strong>Default</strong>: <code>protected</code></li></ul><hr /></section><a name="skip"><section> <h4><a name="a.3Cskip.3E"></a><skip></h4><a name="a.3Cskip.3E"></a></a> @@ -1887,7 +1891,7 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.5</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>maven.javadoc.skip</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="skippedModules"><section> <h4><a name="a.3CskippedModules.3E"></a><skippedModules></h4><a name="a.3CskippedModules.3E"></a></a> @@ -1895,13 +1899,13 @@ or <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>maven.javadoc.skippedModules</code></li></ul><hr /></section><a name="source"><section> <h4><a name="a.3Csource.3E"></a><source></h4><a name="a.3Csource.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>source</code></li> <li><strong>Default</strong>: <code>${maven.compiler.source}</code></li></ul><hr /></section><a name="sourceDependencyCacheDir"><section> <h4><a name="a.3CsourceDependencyCacheDir.3E"></a><sourceDependencyCacheDir></h4><a name="a.3CsourceDependencyCacheDir.3E"></a></a> @@ -1909,32 +1913,32 @@ or <ul> <li><strong>Type</strong>: <code>java.io.File</code></li> <li><strong>Since</strong>: <code>2.7</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>Default</strong>: <code>${project.build.directory}/distro-javadoc-sources</code></li></ul><hr /></section><a name="sourceFileExcludes"><section> <h4><a name="a.3CsourceFileExcludes.3E"></a><sourceFileExcludes></h4><a name="a.3CsourceFileExcludes.3E"></a></a> <div>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</div> <ul> <li><strong>Type</strong>: <code>java.util.List<java.lang.String></code></li> <li><strong>Since</strong>: <code>2.9</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li></ul><hr /></section><a name="sourceFileIncludes"><section> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="sourceFileIncludes"><section> <h4><a name="a.3CsourceFileIncludes.3E"></a><sourceFileIncludes></h4><a name="a.3CsourceFileIncludes.3E"></a></a> <div>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</div> <ul> <li><strong>Type</strong>: <code>java.util.List<java.lang.String></code></li> <li><strong>Since</strong>: <code>2.9</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li></ul><hr /></section><a name="sourcepath"><section> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="sourcepath"><section> <h4><a name="a.3Csourcepath.3E"></a><sourcepath></h4><a name="a.3Csourcepath.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>sourcepath</code></li></ul><hr /></section><a name="sourcetab"><section> <h4><a name="a.3Csourcetab.3E"></a><sourcetab></h4><a name="a.3Csourcetab.3E"></a></a> <div>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></div> <ul> <li><strong>Type</strong>: <code>int</code></li> <li><strong>Since</strong>: <code>2.1</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>sourcetab</code></li> <li><strong>Alias</strong>: <code>linksourcetab</code></li></ul><hr /></section><a name="splitindex"><section> <h4><a name="a.3Csplitindex.3E"></a><splitindex></h4><a name="a.3Csplitindex.3E"></a></a> @@ -1942,7 +1946,7 @@ or <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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>splitindex</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="staleDataPath"><section> <h4><a name="a.3CstaleDataPath.3E"></a><staleDataPath></h4><a name="a.3CstaleDataPath.3E"></a></a> @@ -1950,17 +1954,17 @@ or <ul> <li><strong>Type</strong>: <code>java.io.File</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>staleDataPath</code></li> <li><strong>Default</strong>: <code>${project.build.directory}/maven-javadoc-plugin-stale-data.txt</code></li></ul><hr /></section><a name="stylesheet"><section> <h4><a name="a.3Cstylesheet.3E"></a><stylesheet></h4><a name="a.3Cstylesheet.3E"></a></a> -<div><strong>Deprecated.</strong> This is no longer evaluated, instead use <a href="#addStylesheets"><code>addStylesheets</code></a> to customize the CSS.</div> +<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 /> <div>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></div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>stylesheet</code></li> <li><strong>Default</strong>: <code>java</code></li></ul><hr /></section><a name="stylesheetfile"><section> <h4><a name="a.3Cstylesheetfile.3E"></a><stylesheetfile></h4><a name="a.3Cstylesheetfile.3E"></a></a> @@ -1996,19 +2000,19 @@ or </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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>stylesheetfile</code></li></ul><hr /></section><a name="subpackages"><section> <h4><a name="a.3Csubpackages.3E"></a><subpackages></h4><a name="a.3Csubpackages.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>subpackages</code></li></ul><hr /></section><a name="taglet"><section> <h4><a name="a.3Ctaglet.3E"></a><taglet></h4><a name="a.3Ctaglet.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>taglet</code></li></ul><hr /></section><a name="tagletArtifact"><section> <h4><a name="a.3CtagletArtifact.3E"></a><tagletArtifact></h4><a name="a.3CtagletArtifact.3E"></a></a> <div>Specifies the Taglet artifact containing the taglet class files (.class). @@ -2035,7 +2039,7 @@ or <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/TagletArtifact.html"><code>org.apache.maven.plugins.javadoc.options.TagletArtifact</code></a></li> <li><strong>Since</strong>: <code>2.1</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>tagletArtifact</code></li></ul><hr /></section><a name="tagletArtifacts"><section> <h4><a name="a.3CtagletArtifacts.3E"></a><tagletArtifacts></h4><a name="a.3CtagletArtifacts.3E"></a></a> <div>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. @@ -2056,13 +2060,13 @@ or <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/TagletArtifact.html"><code>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</code></a></li> <li><strong>Since</strong>: <code>2.5</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>tagletArtifacts</code></li></ul><hr /></section><a name="tagletpath"><section> <h4><a name="a.3Ctagletpath.3E"></a><tagletpath></h4><a name="a.3Ctagletpath.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>tagletpath</code></li></ul><hr /></section><a name="taglets"><section> <h4><a name="a.3Ctaglets.3E"></a><taglets></h4><a name="a.3Ctaglets.3E"></a></a> <div>Enables the Javadoc tool to interpret multiple taglets. @@ -2087,7 +2091,7 @@ or <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/Taglet.html"><code>org.apache.maven.plugins.javadoc.options.Taglet[]</code></a></li> <li><strong>Since</strong>: <code>2.1</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>taglets</code></li></ul><hr /></section><a name="tags"><section> <h4><a name="a.3Ctags.3E"></a><tags></h4><a name="a.3Ctags.3E"></a></a> <div>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments. @@ -2114,20 +2118,20 @@ or </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>.</div> <ul> <li><strong>Type</strong>: <a href="apidocs/org/apache/maven/plugins/javadoc/options/Tag.html"><code>org.apache.maven.plugins.javadoc.options.Tag[]</code></a></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>tags</code></li></ul><hr /></section><a name="top"><section> <h4><a name="a.3Ctop.3E"></a><top></h4><a name="a.3Ctop.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>2.4</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>top</code></li></ul><hr /></section><a name="use"><section> <h4><a name="a.3Cuse.3E"></a><use></h4><a name="a.3Cuse.3E"></a></a> <div>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>.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>use</code></li> <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="useDefaultManifestFile"><section> <h4><a name="a.3CuseDefaultManifestFile.3E"></a><useDefaultManifestFile></h4><a name="a.3CuseDefaultManifestFile.3E"></a></a> @@ -2136,7 +2140,7 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.5</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="useStandardDocletOptions"><section> <h4><a name="a.3CuseStandardDocletOptions.3E"></a><useStandardDocletOptions></h4><a name="a.3CuseStandardDocletOptions.3E"></a></a> <div>Specifies to use the <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options";> options provided by the Standard Doclet</a> for a custom doclet. @@ -2155,7 +2159,7 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.5</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>useStandardDocletOptions</code></li> <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="validateLinks"><section> <h4><a name="a.3CvalidateLinks.3E"></a><validateLinks></h4><a name="a.3CvalidateLinks.3E"></a></a> @@ -2163,28 +2167,28 @@ or <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>2.8</code></li> -<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>validateLinks</code></li> <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="verbose"><section> <h4><a name="a.3Cverbose.3E"></a><verbose></h4><a name="a.3Cverbose.3E"></a></a>
[... 34 lines stripped ...]
