33287 lines
2.1 MiB
33287 lines
2.1 MiB
diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml
|
|
--- maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml 1970-01-01 01:00:00.000000000 +0100
|
|
+++ maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml 2023-09-20 09:00:08.850415621 +0200
|
|
@@ -0,0 +1,13453 @@
|
|
+<?xml version="1.0" encoding="UTF-8"?>
|
|
+
|
|
+<!-- Generated by maven-plugin-tools 3.6 -->
|
|
+
|
|
+<plugin>
|
|
+ <name>${project.name}</name>
|
|
+ <description>${project.description}</description>
|
|
+ <groupId>${project.groupId}</groupId>
|
|
+ <artifactId>${project.artifactId}</artifactId>
|
|
+ <version>${project.version}</version>
|
|
+ <goalPrefix>javadoc</goalPrefix>
|
|
+ <mojos>
|
|
+ <mojo>
|
|
+ <goal>aggregate</goal>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>true</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorJavadocReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.5</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="apidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/apidocs">${reportOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>aggregate-jar</goal>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>true</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <executePhase>compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorJavadocJar</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.6</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <attach implementation="boolean" default-value="true">${attach}</attach>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <classifier implementation="java.lang.String" default-value="javadoc">${maven.javadoc.classifier}</classifier>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <destDir implementation="java.io.File">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String">${project.build.finalName}</finalName>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <jarOutputDirectory implementation="java.lang.String">${project.build.directory}</jarOutputDirectory>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useDefaultManifestFile implementation="boolean" default-value="false"/>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>aggregate-no-fork</goal>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorJavadocNoForkReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>3.1.0</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="apidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/apidocs">${reportOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>fix</goal>
|
|
+ <description>Fix Javadoc documentation and tags for the Java code for the project.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.FixJavadocMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.6</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>comparisonVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultAuthor</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultSince</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixClassComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixFieldComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixMethodComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixTags</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>force</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>ignoreClirr</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>level</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>removeUnknownThrows</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <comparisonVersion implementation="java.lang.String" default-value="(,${project.version})">${comparisonVersion}</comparisonVersion>
|
|
+ <defaultAuthor implementation="java.lang.String">${defaultAuthor}</defaultAuthor>
|
|
+ <defaultSince implementation="java.lang.String" default-value="${project.version}">${defaultSince}</defaultSince>
|
|
+ <defaultVersion implementation="java.lang.String" default-value="$Id: $Id">${defaultVersion}</defaultVersion>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludes implementation="java.lang.String">${excludes}</excludes>
|
|
+ <fixClassComment implementation="boolean" default-value="true">${fixClassComment}</fixClassComment>
|
|
+ <fixFieldComment implementation="boolean" default-value="true">${fixFieldComment}</fixFieldComment>
|
|
+ <fixMethodComment implementation="boolean" default-value="true">${fixMethodComment}</fixMethodComment>
|
|
+ <fixTags implementation="java.lang.String" default-value="all">${fixTags}</fixTags>
|
|
+ <force implementation="boolean">${force}</force>
|
|
+ <ignoreClirr implementation="boolean" default-value="false">${ignoreClirr}</ignoreClirr>
|
|
+ <includes implementation="java.lang.String" default-value="**\/*.java">${includes}</includes>
|
|
+ <level implementation="java.lang.String" default-value="protected">${level}</level>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.sourceDirectory}">${outputDirectory}</outputDirectory>
|
|
+ <removeUnknownThrows implementation="boolean" default-value="true">${removeUnknownThrows}</removeUnknownThrows>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>help</goal>
|
|
+ <description>Display help information on maven-javadoc-plugin.
|
|
+Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.</description>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>false</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.HelpMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>detail</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Display help information on maven-javadoc-plugin.
|
|
+Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>goal</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Display help information on maven-javadoc-plugin.
|
|
+Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>indentSize</name>
|
|
+ <type>int</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Display help information on maven-javadoc-plugin.
|
|
+Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>lineLength</name>
|
|
+ <type>int</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Display help information on maven-javadoc-plugin.
|
|
+Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <detail implementation="boolean" default-value="false">${detail}</detail>
|
|
+ <goal implementation="java.lang.String">${goal}</goal>
|
|
+ <indentSize implementation="int" default-value="2">${indentSize}</indentSize>
|
|
+ <lineLength implementation="int" default-value="80">${lineLength}</lineLength>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>jar</goal>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.JavadocJar</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.0</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <attach implementation="boolean" default-value="true">${attach}</attach>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <classifier implementation="java.lang.String" default-value="javadoc">${maven.javadoc.classifier}</classifier>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <destDir implementation="java.io.File">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String">${project.build.finalName}</finalName>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <jarOutputDirectory implementation="java.lang.String">${project.build.directory}</jarOutputDirectory>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useDefaultManifestFile implementation="boolean" default-value="false"/>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>javadoc</goal>
|
|
+ <description>Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>generate-sources</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.JavadocReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.0</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="apidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/apidocs">${reportOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>javadoc-no-fork</goal>
|
|
+ <description>Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.JavadocNoForkReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.10</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="apidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/apidocs">${reportOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>resource-bundle</goal>
|
|
+ <description>Bundle {@link AbstractJavadocMojo#javadocDirectory}, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.ResourcesBundleMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.7</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-aggregate</goal>
|
|
+ <description>Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>true</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>test-compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorTestJavadocReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.5</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDescription</name>
|
|
+ <alias>description</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testName</name>
|
|
+ <alias>name</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="testapidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/testapidocs">${reportTestOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testDescription implementation="java.lang.String">${testDescription}</testDescription>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testName implementation="java.lang.String">${testName}</testName>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-aggregate-jar</goal>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>true</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <executePhase>test-compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorTestJavadocJar</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.6</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testClassifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <attach implementation="boolean" default-value="true">${attach}</attach>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <classifier implementation="java.lang.String" default-value="javadoc">${maven.javadoc.classifier}</classifier>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <destDir implementation="java.io.File">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String">${project.build.finalName}</finalName>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <jarOutputDirectory implementation="java.lang.String">${project.build.directory}</jarOutputDirectory>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/testapidocs"/>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testClassifier implementation="java.lang.String" default-value="test-javadoc">${maven.javadoc.testClassifier}</testClassifier>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useDefaultManifestFile implementation="boolean" default-value="false"/>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-aggregate-no-fork</goal>
|
|
+ <description>Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorTestJavadocNoForkReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>3.0.1</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDescription</name>
|
|
+ <alias>description</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testName</name>
|
|
+ <alias>name</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="testapidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/testapidocs">${reportTestOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testDescription implementation="java.lang.String">${testDescription}</testDescription>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testName implementation="java.lang.String">${testName}</testName>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-fix</goal>
|
|
+ <description>Fix Javadoc documentation and tags for the Test Java code for the project.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>test-compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestFixJavadocMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.6</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>comparisonVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultAuthor</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultSince</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixClassComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixFieldComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixMethodComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixTags</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>force</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>ignoreClirr</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>level</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>removeUnknownThrows</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <comparisonVersion implementation="java.lang.String" default-value="(,${project.version})">${comparisonVersion}</comparisonVersion>
|
|
+ <defaultAuthor implementation="java.lang.String">${defaultAuthor}</defaultAuthor>
|
|
+ <defaultSince implementation="java.lang.String" default-value="${project.version}">${defaultSince}</defaultSince>
|
|
+ <defaultVersion implementation="java.lang.String" default-value="$Id: $Id">${defaultVersion}</defaultVersion>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludes implementation="java.lang.String">${excludes}</excludes>
|
|
+ <fixClassComment implementation="boolean" default-value="true">${fixClassComment}</fixClassComment>
|
|
+ <fixFieldComment implementation="boolean" default-value="true">${fixFieldComment}</fixFieldComment>
|
|
+ <fixMethodComment implementation="boolean" default-value="true">${fixMethodComment}</fixMethodComment>
|
|
+ <fixTags implementation="java.lang.String" default-value="all">${fixTags}</fixTags>
|
|
+ <force implementation="boolean">${force}</force>
|
|
+ <ignoreClirr implementation="boolean" default-value="false">${ignoreClirr}</ignoreClirr>
|
|
+ <includes implementation="java.lang.String" default-value="**\/*.java">${includes}</includes>
|
|
+ <level implementation="java.lang.String" default-value="protected">${level}</level>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.sourceDirectory}">${outputDirectory}</outputDirectory>
|
|
+ <removeUnknownThrows implementation="boolean" default-value="true">${removeUnknownThrows}</removeUnknownThrows>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-jar</goal>
|
|
+ <description>Bundles the Javadoc documentation for test Java code in an NON aggregator project into a jar using the standard Javadoc Tool.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestJavadocJar</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.5</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testClassifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <attach implementation="boolean" default-value="true">${attach}</attach>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <classifier implementation="java.lang.String" default-value="javadoc">${maven.javadoc.classifier}</classifier>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <destDir implementation="java.io.File">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String">${project.build.finalName}</finalName>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <jarOutputDirectory implementation="java.lang.String">${project.build.directory}</jarOutputDirectory>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/testapidocs"/>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testClassifier implementation="java.lang.String" default-value="test-javadoc">${maven.javadoc.testClassifier}</testClassifier>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useDefaultManifestFile implementation="boolean" default-value="false"/>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-javadoc</goal>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>generate-test-sources</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestJavadocReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.3</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDescription</name>
|
|
+ <alias>description</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testName</name>
|
|
+ <alias>name</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="testapidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/testapidocs">${reportTestOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testDescription implementation="java.lang.String">${testDescription}</testDescription>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testName implementation="java.lang.String">${testName}</testName>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-javadoc-no-fork</goal>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestJavadocNoForkReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.10</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDescription</name>
|
|
+ <alias>description</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testName</name>
|
|
+ <alias>name</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="testapidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/testapidocs">${reportTestOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testDescription implementation="java.lang.String">${testDescription}</testDescription>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testName implementation="java.lang.String">${testName}</testName>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-resource-bundle</goal>
|
|
+ <description>Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from {@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestResourcesBundleMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.7</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from {@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ </mojos>
|
|
+</plugin>
|
|
diff -urEbwBN maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/plugin.xml maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/plugin.xml
|
|
--- maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/plugin.xml 1970-01-01 01:00:00.000000000 +0100
|
|
+++ maven-javadoc-plugin-3.6.0/src/main/filtered-resources/META-INF/maven/plugin.xml 2023-09-20 08:59:15.926733566 +0200
|
|
@@ -0,0 +1,19825 @@
|
|
+<?xml version="1.0" encoding="UTF-8"?>
|
|
+
|
|
+<!-- Generated by maven-plugin-tools 3.6 -->
|
|
+
|
|
+<plugin>
|
|
+ <name>${project.name}</name>
|
|
+ <description>${project.description}</description>
|
|
+ <groupId>${project.groupId}</groupId>
|
|
+ <artifactId>${project.artifactId}</artifactId>
|
|
+ <version>${project.version}</version>
|
|
+ <goalPrefix>javadoc</goalPrefix>
|
|
+ <isolatedRealm>false</isolatedRealm>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <mojos>
|
|
+ <mojo>
|
|
+ <goal>aggregate</goal>
|
|
+ <description><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>Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.</p></description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>true</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorJavadocReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.5</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>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>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>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>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="apidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/apidocs">${reportOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>aggregate-jar</goal>
|
|
+ <description><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></description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>true</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <executePhase>compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorJavadocJar</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.6</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultManifestFile</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <attach implementation="boolean" default-value="true">${attach}</attach>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <classifier implementation="java.lang.String" default-value="javadoc">${maven.javadoc.classifier}</classifier>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <defaultManifestFile implementation="java.io.File" default-value="${project.build.outputDirectory}/META-INF/MANIFEST.MF"/>
|
|
+ <destDir implementation="java.io.File">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String">${project.build.finalName}</finalName>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <jarOutputDirectory implementation="java.lang.String">${project.build.directory}</jarOutputDirectory>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useDefaultManifestFile implementation="boolean" default-value="false"/>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.Archiver</role>
|
|
+ <role-hint>jar</role-hint>
|
|
+ <field-name>jarArchiver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.MavenProjectHelper</role>
|
|
+ <field-name>projectHelper</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>aggregate-no-fork</goal>
|
|
+ <description>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>.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorJavadocNoForkReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>3.1.0</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>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>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>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>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="apidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/apidocs">${reportOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>fix</goal>
|
|
+ <description>Fix Javadoc documentation and tags for the <code>Java code</code> for the project.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.FixJavadocMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.6</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>comparisonVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultAuthor</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultSince</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixClassComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixFieldComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixMethodComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixTags</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>force</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>ignoreClirr</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>level</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>removeUnknownThrows</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <comparisonVersion implementation="java.lang.String" default-value="(,${project.version})">${comparisonVersion}</comparisonVersion>
|
|
+ <defaultAuthor implementation="java.lang.String">${defaultAuthor}</defaultAuthor>
|
|
+ <defaultSince implementation="java.lang.String" default-value="${project.version}">${defaultSince}</defaultSince>
|
|
+ <defaultVersion implementation="java.lang.String" default-value="$Id: $Id">${defaultVersion}</defaultVersion>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludes implementation="java.lang.String">${excludes}</excludes>
|
|
+ <fixClassComment implementation="boolean" default-value="true">${fixClassComment}</fixClassComment>
|
|
+ <fixFieldComment implementation="boolean" default-value="true">${fixFieldComment}</fixFieldComment>
|
|
+ <fixMethodComment implementation="boolean" default-value="true">${fixMethodComment}</fixMethodComment>
|
|
+ <fixTags implementation="java.lang.String" default-value="all">${fixTags}</fixTags>
|
|
+ <force implementation="boolean">${force}</force>
|
|
+ <ignoreClirr implementation="boolean" default-value="false">${ignoreClirr}</ignoreClirr>
|
|
+ <includes implementation="java.lang.String" default-value="**\/*.java">${includes}</includes>
|
|
+ <level implementation="java.lang.String" default-value="protected">${level}</level>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.sourceDirectory}">${outputDirectory}</outputDirectory>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <removeUnknownThrows implementation="boolean" default-value="true">${removeUnknownThrows}</removeUnknownThrows>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.components.interactivity.InputHandler</role>
|
|
+ <field-name>inputHandler</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>help</goal>
|
|
+ <description>Display help information on maven-javadoc-plugin.<br>
|
|
+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</description>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>false</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.HelpMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>detail</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Display help information on maven-javadoc-plugin.<br>
|
|
+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>goal</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Display help information on maven-javadoc-plugin.<br>
|
|
+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>indentSize</name>
|
|
+ <type>int</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Display help information on maven-javadoc-plugin.<br>
|
|
+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>lineLength</name>
|
|
+ <type>int</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Display help information on maven-javadoc-plugin.<br>
|
|
+Call <code>mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <detail implementation="boolean" default-value="false">${detail}</detail>
|
|
+ <goal implementation="java.lang.String">${goal}</goal>
|
|
+ <indentSize implementation="int" default-value="2">${indentSize}</indentSize>
|
|
+ <lineLength implementation="int" default-value="80">${lineLength}</lineLength>
|
|
+ </configuration>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>jar</goal>
|
|
+ <description>Bundles the Javadoc documentation for <code>main Java code</code> in an <b>NON aggregator</b> project into
|
|
+a jar using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">
|
|
+Javadoc Tool</a>.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.JavadocJar</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.0</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultManifestFile</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <attach implementation="boolean" default-value="true">${attach}</attach>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <classifier implementation="java.lang.String" default-value="javadoc">${maven.javadoc.classifier}</classifier>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <defaultManifestFile implementation="java.io.File" default-value="${project.build.outputDirectory}/META-INF/MANIFEST.MF"/>
|
|
+ <destDir implementation="java.io.File">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String">${project.build.finalName}</finalName>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <jarOutputDirectory implementation="java.lang.String">${project.build.directory}</jarOutputDirectory>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useDefaultManifestFile implementation="boolean" default-value="false"/>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.Archiver</role>
|
|
+ <role-hint>jar</role-hint>
|
|
+ <field-name>jarArchiver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.MavenProjectHelper</role>
|
|
+ <field-name>projectHelper</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>javadoc</goal>
|
|
+ <description>Generates documentation for the <code>Java code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>generate-sources</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.JavadocReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.0</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>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>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>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>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="apidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/apidocs">${reportOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>javadoc-no-fork</goal>
|
|
+ <description>Generates documentation for the <code>Java code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of sources before site generation, e.g. by invoking {@code mvn clean deploy site}.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.JavadocNoForkReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.10</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>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>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>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>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="apidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/apidocs">${reportOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>resource-bundle</goal>
|
|
+ <description>Bundle {@link AbstractJavadocMojo#javadocDirectory}, along with javadoc configuration options such
|
|
+as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed
|
|
+by the javadoc plugin mojos when used by the <code>includeDependencySources</code> option, to generate
|
|
+javadocs that are somewhat consistent with those generated in the original project itself.</description>
|
|
+ <requiresDependencyResolution>compile</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.ResourcesBundleMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.7</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from
|
|
+{@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable
|
|
+artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the
|
|
+<code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent
|
|
+with those generated in the original project itself.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String" default-value="${project.build.finalName}"/>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.MavenProjectHelper</role>
|
|
+ <field-name>projectHelper</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-aggregate</goal>
|
|
+ <description><p>Generates documentation for the <code>Java Test code</code> in an <b>aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.</p></description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>true</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>test-compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorTestJavadocReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.5</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDescription</name>
|
|
+ <alias>description</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testName</name>
|
|
+ <alias>name</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="testapidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/testapidocs">${reportTestOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testDescription implementation="java.lang.String">${testDescription}</testDescription>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testName implementation="java.lang.String">${testName}</testName>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-aggregate-jar</goal>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>true</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <executePhase>test-compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorTestJavadocJar</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.6</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultManifestFile</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testClassifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <attach implementation="boolean" default-value="true">${attach}</attach>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <classifier implementation="java.lang.String" default-value="javadoc">${maven.javadoc.classifier}</classifier>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <defaultManifestFile implementation="java.io.File" default-value="${project.build.outputDirectory}/META-INF/MANIFEST.MF"/>
|
|
+ <destDir implementation="java.io.File">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String">${project.build.finalName}</finalName>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <jarOutputDirectory implementation="java.lang.String">${project.build.directory}</jarOutputDirectory>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/testapidocs"/>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testClassifier implementation="java.lang.String" default-value="test-javadoc">${maven.javadoc.testClassifier}</testClassifier>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useDefaultManifestFile implementation="boolean" default-value="false"/>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.Archiver</role>
|
|
+ <role-hint>jar</role-hint>
|
|
+ <field-name>jarArchiver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.MavenProjectHelper</role>
|
|
+ <field-name>projectHelper</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-aggregate-no-fork</goal>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.AggregatorTestJavadocNoForkReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>3.0.1</since>
|
|
+ <threadSafe>false</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDescription</name>
|
|
+ <alias>description</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testName</name>
|
|
+ <alias>name</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="testapidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/testapidocs">${reportTestOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testDescription implementation="java.lang.String">${testDescription}</testDescription>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testName implementation="java.lang.String">${testName}</testName>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-fix</goal>
|
|
+ <description>Fix Javadoc documentation and tags for the <code>Test Java code</code> for the project.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>test-compile</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestFixJavadocMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.6</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>comparisonVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultAuthor</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultSince</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixClassComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixFieldComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixMethodComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixTags</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>force</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>ignoreClirr</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>level</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>removeUnknownThrows</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Abstract class to fix Javadoc documentation and tags in source files.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <comparisonVersion implementation="java.lang.String" default-value="(,${project.version})">${comparisonVersion}</comparisonVersion>
|
|
+ <defaultAuthor implementation="java.lang.String">${defaultAuthor}</defaultAuthor>
|
|
+ <defaultSince implementation="java.lang.String" default-value="${project.version}">${defaultSince}</defaultSince>
|
|
+ <defaultVersion implementation="java.lang.String" default-value="$Id: $Id">${defaultVersion}</defaultVersion>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludes implementation="java.lang.String">${excludes}</excludes>
|
|
+ <fixClassComment implementation="boolean" default-value="true">${fixClassComment}</fixClassComment>
|
|
+ <fixFieldComment implementation="boolean" default-value="true">${fixFieldComment}</fixFieldComment>
|
|
+ <fixMethodComment implementation="boolean" default-value="true">${fixMethodComment}</fixMethodComment>
|
|
+ <fixTags implementation="java.lang.String" default-value="all">${fixTags}</fixTags>
|
|
+ <force implementation="boolean">${force}</force>
|
|
+ <ignoreClirr implementation="boolean" default-value="false">${ignoreClirr}</ignoreClirr>
|
|
+ <includes implementation="java.lang.String" default-value="**\/*.java">${includes}</includes>
|
|
+ <level implementation="java.lang.String" default-value="protected">${level}</level>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.sourceDirectory}">${outputDirectory}</outputDirectory>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <removeUnknownThrows implementation="boolean" default-value="true">${removeUnknownThrows}</removeUnknownThrows>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.components.interactivity.InputHandler</role>
|
|
+ <field-name>inputHandler</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-jar</goal>
|
|
+ <description>Bundles the Javadoc documentation for <code>test Java code</code> in an <b>NON aggregator</b> project into
|
|
+a jar using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">
|
|
+Javadoc Tool</a>.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestJavadocJar</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.5</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultManifestFile</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testClassifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><p>Bundles the Javadoc documentation for <code>Java Test code</code> in an <b>aggregator</b> project into a jar
|
|
+using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
|
|
+</p>
|
|
+
|
|
+<p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description><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></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <attach implementation="boolean" default-value="true">${attach}</attach>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <classifier implementation="java.lang.String" default-value="javadoc">${maven.javadoc.classifier}</classifier>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <defaultManifestFile implementation="java.io.File" default-value="${project.build.outputDirectory}/META-INF/MANIFEST.MF"/>
|
|
+ <destDir implementation="java.io.File">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String">${project.build.finalName}</finalName>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <jarOutputDirectory implementation="java.lang.String">${project.build.directory}</jarOutputDirectory>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/testapidocs"/>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testClassifier implementation="java.lang.String" default-value="test-javadoc">${maven.javadoc.testClassifier}</testClassifier>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useDefaultManifestFile implementation="boolean" default-value="false"/>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.Archiver</role>
|
|
+ <role-hint>jar</role-hint>
|
|
+ <field-name>jarArchiver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.MavenProjectHelper</role>
|
|
+ <field-name>projectHelper</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-javadoc</goal>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <executePhase>generate-test-sources</executePhase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestJavadocReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.3</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDescription</name>
|
|
+ <alias>description</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testName</name>
|
|
+ <alias>name</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="testapidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/testapidocs">${reportTestOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testDescription implementation="java.lang.String">${testDescription}</testDescription>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testName implementation="java.lang.String">${testName}</testName>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-javadoc-no-fork</goal>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestJavadocNoForkReport</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.10</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>destDir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reportOutputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDescription</name>
|
|
+ <alias>description</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testDoctitle</name>
|
|
+ <alias>doctitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testName</name>
|
|
+ <alias>name</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testOverview</name>
|
|
+ <alias>overview</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testWindowtitle</name>
|
|
+ <alias>windowtitle</alias>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <description implementation="java.lang.String">${description}</description>
|
|
+ <destDir implementation="java.lang.String" default-value="testapidocs">${destDir}</destDir>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <name implementation="java.lang.String">${name}</name>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <reportOutputDirectory implementation="java.io.File" default-value="${project.reporting.outputDirectory}/testapidocs">${reportTestOutputDirectory}</reportOutputDirectory>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testDescription implementation="java.lang.String">${testDescription}</testDescription>
|
|
+ <testDoctitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testDoctitle}</testDoctitle>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <testName implementation="java.lang.String">${testName}</testName>
|
|
+ <testOverview implementation="java.io.File" default-value="${basedir}/src/test/javadoc/overview.html">${testOverview}</testOverview>
|
|
+ <testWindowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} Test API">${testWindowtitle}</testWindowtitle>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ <mojo>
|
|
+ <goal>test-resource-bundle</goal>
|
|
+ <description>Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from
|
|
+{@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable
|
|
+artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the
|
|
+<code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent
|
|
+with those generated in the original project itself.</description>
|
|
+ <requiresDependencyResolution>test</requiresDependencyResolution>
|
|
+ <requiresDirectInvocation>false</requiresDirectInvocation>
|
|
+ <requiresProject>true</requiresProject>
|
|
+ <requiresReports>false</requiresReports>
|
|
+ <aggregator>false</aggregator>
|
|
+ <requiresOnline>false</requiresOnline>
|
|
+ <inheritedByDefault>true</inheritedByDefault>
|
|
+ <phase>package</phase>
|
|
+ <implementation>org.apache.maven.plugins.javadoc.TestResourcesBundleMojo</implementation>
|
|
+ <language>java</language>
|
|
+ <instantiationStrategy>per-lookup</instantiationStrategy>
|
|
+ <executionStrategy>once-per-session</executionStrategy>
|
|
+ <since>2.7</since>
|
|
+ <threadSafe>true</threadSafe>
|
|
+ <parameters>
|
|
+ <parameter>
|
|
+ <name>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspathArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from
|
|
+{@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable
|
|
+artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the
|
|
+<code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent
|
|
+with those generated in the original project itself.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeTransitiveDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <deprecated>if these sources depend on transitive dependencies, those dependencies should be added to the pom as
|
|
+ direct dependencies</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojo</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <alias>destDir</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>resourcesArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use {@link #addStylesheets} to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletArtifacts</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.TagletArtifact[]</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglets</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Taglet[]</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from
|
|
+{@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable
|
|
+artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the
|
|
+<code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent
|
|
+with those generated in the original project itself.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
|
|
+<a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
|
|
+goal does require generation of test sources before site generation, e.g. by invoking
|
|
+{@code mvn clean deploy site}.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <additionalJOption implementation="java.lang.String">${additionalJOption}</additionalJOption>
|
|
+ <applyJavadocSecurityFix implementation="boolean" default-value="true">${maven.javadoc.applyJavadocSecurityFix}</applyJavadocSecurityFix>
|
|
+ <author implementation="boolean" default-value="true">${author}</author>
|
|
+ <bootclasspath implementation="java.lang.String">${bootclasspath}</bootclasspath>
|
|
+ <bootclasspathArtifacts implementation="org.apache.maven.plugins.javadoc.options.BootclasspathArtifact[]">${bootclasspathArtifacts}</bootclasspathArtifacts>
|
|
+ <bottom implementation="java.lang.String" default-value="Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.">${bottom}</bottom>
|
|
+ <breakiterator implementation="boolean" default-value="false">${breakiterator}</breakiterator>
|
|
+ <charset implementation="java.lang.String">${charset}</charset>
|
|
+ <debug implementation="boolean" default-value="false">${debug}</debug>
|
|
+ <detectJavaApiLink implementation="boolean" default-value="true">${detectJavaApiLink}</detectJavaApiLink>
|
|
+ <detectLinks implementation="boolean" default-value="false">${detectLinks}</detectLinks>
|
|
+ <detectOfflineLinks implementation="boolean" default-value="true">${detectOfflineLinks}</detectOfflineLinks>
|
|
+ <docencoding implementation="java.lang.String" default-value="${project.reporting.outputEncoding}">${docencoding}</docencoding>
|
|
+ <docfilessubdirs implementation="boolean" default-value="false">${docfilessubdirs}</docfilessubdirs>
|
|
+ <doclet implementation="java.lang.String">${doclet}</doclet>
|
|
+ <docletArtifact implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact">${docletArtifact}</docletArtifact>
|
|
+ <docletArtifacts implementation="org.apache.maven.plugins.javadoc.options.DocletArtifact[]">${docletArtifacts}</docletArtifacts>
|
|
+ <docletPath implementation="java.lang.String">${docletPath}</docletPath>
|
|
+ <doclint implementation="java.lang.String">${doclint}</doclint>
|
|
+ <doctitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${doctitle}</doctitle>
|
|
+ <encoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${encoding}</encoding>
|
|
+ <excludePackageNames implementation="java.lang.String">${excludePackageNames}</excludePackageNames>
|
|
+ <excludedocfilessubdir implementation="java.lang.String">${excludedocfilessubdir}</excludedocfilessubdir>
|
|
+ <extdirs implementation="java.lang.String">${extdirs}</extdirs>
|
|
+ <failOnError implementation="boolean" default-value="true">${maven.javadoc.failOnError}</failOnError>
|
|
+ <failOnWarnings implementation="boolean" default-value="false">${maven.javadoc.failOnWarnings}</failOnWarnings>
|
|
+ <finalName implementation="java.lang.String" default-value="${project.build.finalName}"/>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <header implementation="java.lang.String">${header}</header>
|
|
+ <helpfile implementation="java.lang.String">${helpfile}</helpfile>
|
|
+ <includeDependencySources implementation="boolean" default-value="false"/>
|
|
+ <includeTransitiveDependencySources implementation="boolean" default-value="false"/>
|
|
+ <javaApiLinks implementation="java.util.Properties">${javaApiLinks}</javaApiLinks>
|
|
+ <javadocDirectory implementation="java.io.File" default-value="${basedir}/src/main/javadoc"/>
|
|
+ <javadocExecutable implementation="java.lang.String">${javadocExecutable}</javadocExecutable>
|
|
+ <javadocOptionsDir implementation="java.io.File" default-value="${project.build.directory}/javadoc-bundle-options"/>
|
|
+ <javadocVersion implementation="java.lang.String">${javadocVersion}</javadocVersion>
|
|
+ <keywords implementation="boolean" default-value="false">${keywords}</keywords>
|
|
+ <legacyMode implementation="boolean" default-value="false">${legacyMode}</legacyMode>
|
|
+ <links implementation="java.util.ArrayList">${links}</links>
|
|
+ <linksource implementation="boolean" default-value="false">${linksource}</linksource>
|
|
+ <locale implementation="java.lang.String">${locale}</locale>
|
|
+ <maxmemory implementation="java.lang.String">${maxmemory}</maxmemory>
|
|
+ <minmemory implementation="java.lang.String">${minmemory}</minmemory>
|
|
+ <mojo implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/>
|
|
+ <nocomment implementation="boolean" default-value="false">${nocomment}</nocomment>
|
|
+ <nodeprecated implementation="boolean" default-value="false">${nodeprecated}</nodeprecated>
|
|
+ <nodeprecatedlist implementation="boolean" default-value="false">${nodeprecatedlist}</nodeprecatedlist>
|
|
+ <nohelp implementation="boolean" default-value="false">${nohelp}</nohelp>
|
|
+ <noindex implementation="boolean" default-value="false">${noindex}</noindex>
|
|
+ <nonavbar implementation="boolean" default-value="false">${nonavbar}</nonavbar>
|
|
+ <nooverview implementation="boolean" default-value="false">${nooverview}</nooverview>
|
|
+ <noqualifier implementation="java.lang.String">${noqualifier}</noqualifier>
|
|
+ <nosince implementation="boolean" default-value="false">${nosince}</nosince>
|
|
+ <notimestamp implementation="boolean" default-value="false">${notimestamp}</notimestamp>
|
|
+ <notree implementation="boolean" default-value="false">${notree}</notree>
|
|
+ <offline implementation="boolean" default-value="false">${maven.javadoc.offline}</offline>
|
|
+ <offlineLinks implementation="org.apache.maven.plugins.javadoc.options.OfflineLink[]">${offlineLinks}</offlineLinks>
|
|
+ <old implementation="boolean" default-value="false">${old}</old>
|
|
+ <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/apidocs">${destDir}</outputDirectory>
|
|
+ <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/>
|
|
+ <overview implementation="java.io.File" default-value="${basedir}/src/main/javadoc/overview.html">${overview}</overview>
|
|
+ <packagesheader implementation="java.lang.String">${packagesheader}</packagesheader>
|
|
+ <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/>
|
|
+ <quiet implementation="boolean" default-value="false">${quiet}</quiet>
|
|
+ <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects>
|
|
+ <release implementation="java.lang.String" default-value="${maven.compiler.release}"/>
|
|
+ <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/>
|
|
+ <resourcesArtifacts implementation="org.apache.maven.plugins.javadoc.options.ResourcesArtifact[]">${resourcesArtifacts}</resourcesArtifacts>
|
|
+ <serialwarn implementation="boolean" default-value="false">${serialwarn}</serialwarn>
|
|
+ <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/>
|
|
+ <settings implementation="org.apache.maven.settings.Settings" default-value="${settings}"/>
|
|
+ <show implementation="java.lang.String" default-value="protected">${show}</show>
|
|
+ <skip implementation="boolean" default-value="false">${maven.javadoc.skip}</skip>
|
|
+ <skippedModules implementation="java.lang.String">${maven.javadoc.skippedModules}</skippedModules>
|
|
+ <source implementation="java.lang.String" default-value="${maven.compiler.source}">${source}</source>
|
|
+ <sourceDependencyCacheDir implementation="java.io.File" default-value="${project.build.directory}/distro-javadoc-sources"/>
|
|
+ <sourcepath implementation="java.lang.String">${sourcepath}</sourcepath>
|
|
+ <sourcetab implementation="int">${sourcetab}</sourcetab>
|
|
+ <splitindex implementation="boolean" default-value="false">${splitindex}</splitindex>
|
|
+ <staleDataPath implementation="java.io.File" default-value="${project.build.directory}/maven-javadoc-plugin-stale-data.txt">${staleDataPath}</staleDataPath>
|
|
+ <stylesheet implementation="java.lang.String" default-value="java">${stylesheet}</stylesheet>
|
|
+ <stylesheetfile implementation="java.lang.String">${stylesheetfile}</stylesheetfile>
|
|
+ <subpackages implementation="java.lang.String">${subpackages}</subpackages>
|
|
+ <taglet implementation="java.lang.String">${taglet}</taglet>
|
|
+ <tagletArtifact implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact">${tagletArtifact}</tagletArtifact>
|
|
+ <tagletArtifacts implementation="org.apache.maven.plugins.javadoc.options.TagletArtifact[]">${tagletArtifacts}</tagletArtifacts>
|
|
+ <tagletpath implementation="java.lang.String">${tagletpath}</tagletpath>
|
|
+ <taglets implementation="org.apache.maven.plugins.javadoc.options.Taglet[]">${taglets}</taglets>
|
|
+ <tags implementation="org.apache.maven.plugins.javadoc.options.Tag[]">${tags}</tags>
|
|
+ <testJavadocDirectory implementation="java.io.File" default-value="${basedir}/src/test/javadoc"/>
|
|
+ <top implementation="java.lang.String">${top}</top>
|
|
+ <use implementation="boolean" default-value="true">${use}</use>
|
|
+ <useStandardDocletOptions implementation="boolean" default-value="true">${useStandardDocletOptions}</useStandardDocletOptions>
|
|
+ <validateLinks implementation="boolean" default-value="false">${validateLinks}</validateLinks>
|
|
+ <verbose implementation="boolean" default-value="false">${verbose}</verbose>
|
|
+ <version implementation="boolean" default-value="true">${version}</version>
|
|
+ <windowtitle implementation="java.lang.String" default-value="${project.name} ${project.version} API">${windowtitle}</windowtitle>
|
|
+ </configuration>
|
|
+ <requirements>
|
|
+ <requirement>
|
|
+ <role>org.codehaus.plexus.archiver.manager.ArchiverManager</role>
|
|
+ <field-name>archiverManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role>
|
|
+ <field-name>artifactHandlerManager</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.ProjectBuilder</role>
|
|
+ <field-name>mavenProjectBuilder</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.project.MavenProjectHelper</role>
|
|
+ <field-name>projectHelper</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.eclipse.aether.RepositorySystem</role>
|
|
+ <field-name>repoSystem</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.plugins.javadoc.resolver.ResourceResolver</role>
|
|
+ <field-name>resourceResolver</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ </mojos>
|
|
+ <dependencies>
|
|
+ <dependency>
|
|
+ <groupId>org.slf4j</groupId>
|
|
+ <artifactId>slf4j-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.7.36</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-classworlds</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.7.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-component-annotations</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.1.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.eclipse.sisu</groupId>
|
|
+ <artifactId>org.eclipse.sisu.inject</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>0.9.0.M2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>javax.enterprise</groupId>
|
|
+ <artifactId>cdi-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.jboss.spec.javax.interceptor</groupId>
|
|
+ <artifactId>jboss-interceptors-api_1.2_spec</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>any</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>jakarta.inject</groupId>
|
|
+ <artifactId>jakarta.inject-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-interpolation</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.26</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>javax.inject</groupId>
|
|
+ <artifactId>javax.inject</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.reporting</groupId>
|
|
+ <artifactId>maven-reporting-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.1.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven</groupId>
|
|
+ <artifactId>maven-archiver</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.6.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.shared</groupId>
|
|
+ <artifactId>maven-invoker</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.2.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.shared</groupId>
|
|
+ <artifactId>maven-shared-utils</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.4.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.shared</groupId>
|
|
+ <artifactId>maven-common-artifact-filters</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.2.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-sink-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.11.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-logging-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.9.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-site-renderer</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.11.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-skin-model</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.9.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-module-xhtml</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.9.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-velocity</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-decoration-model</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.9.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-container-default</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.0-alpha-30</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.ow2.asm</groupId>
|
|
+ <artifactId>asm-commons</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>5.0.3</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.ow2.asm</groupId>
|
|
+ <artifactId>asm-tree</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>9.5</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.xbean</groupId>
|
|
+ <artifactId>xbean-reflect</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>SYSTEM</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>junit</groupId>
|
|
+ <artifactId>junit</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>SYSTEM</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.hamcrest</groupId>
|
|
+ <artifactId>hamcrest-core</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.3</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>commons-collections</groupId>
|
|
+ <artifactId>commons-collections</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.2.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-core</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.9.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-i18n</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.0-beta-10</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-module-xhtml5</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.9.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.velocity</groupId>
|
|
+ <artifactId>velocity</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.7</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>commons-lang</groupId>
|
|
+ <artifactId>commons-lang</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.4</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.wagon</groupId>
|
|
+ <artifactId>wagon-provider-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.4</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.commons</groupId>
|
|
+ <artifactId>commons-lang3</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.12.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.commons</groupId>
|
|
+ <artifactId>commons-text</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.10.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.httpcomponents</groupId>
|
|
+ <artifactId>httpclient</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>4.5.14</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>commons-logging</groupId>
|
|
+ <artifactId>commons-logging</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>any</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>commons-codec</groupId>
|
|
+ <artifactId>commons-codec</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>any</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.httpcomponents</groupId>
|
|
+ <artifactId>httpcore</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>4.4.16</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>com.thoughtworks.qdox</groupId>
|
|
+ <artifactId>qdox</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.0.3</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-java</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.1.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.ow2.asm</groupId>
|
|
+ <artifactId>asm</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>9.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-utils</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.5.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-io</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.4.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-archiver</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>4.8.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.tukaani</groupId>
|
|
+ <artifactId>xz</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.9</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.commons</groupId>
|
|
+ <artifactId>commons-compress</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.23.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>commons-io</groupId>
|
|
+ <artifactId>commons-io</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.13.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-interactivity-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-component-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.0-alpha-15</version>
|
|
+ </dependency>
|
|
+ </dependencies>
|
|
+</plugin>
|